diff --git a/docs/api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.html b/docs/api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.html
index 367fc59..9b8e652 100644
--- a/docs/api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.html
+++ b/docs/api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.html
@@ -6,7 +6,7 @@
-
+
@@ -96,7 +96,7 @@
Table of Contents
-Interface IWriteOnlyDataHandler<TEntity>
+Interface IWriteOnlyDataHandler<TEntity>
@@ -104,7 +104,8 @@
AssemblyQuickie.dll
-
+ Defines write-only data operations.
+
@@ -116,7 +117,8 @@
Type Parameters
TEntity
-
+ Type of entity
+
@@ -136,10 +138,11 @@ Methods
CreateItemAsync(TEntity, CancellationToken?)
-
+
-
+
@@ -149,15 +152,18 @@
Parameters
item TEntity
-
+ Data to create
+
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj<TEntity>>
-
+ Response object
+
@@ -174,10 +180,11 @@ Returns
CreateItemsAsync(ICollection<TEntity>, CancellationToken?)
-
+
-
+ Create collection of data
+
@@ -187,15 +194,18 @@
Parameters
items ICollection<TEntity>
-
+ Collection of data or items to create
+
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj<ICollection<TEntity>>>
-
+ Response object
+
@@ -212,7 +222,7 @@ Returns
diff --git a/docs/api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.yml b/docs/api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.yml
index 5a3b6a6..35c6ea1 100644
--- a/docs/api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.yml
+++ b/docs/api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.yml
@@ -21,14 +21,17 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: IWriteOnlyDataHandler
path: ../src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
- startLine: 2
+ startLine: 6
assemblies:
- Quickie
namespace: Quickie.DataHandlers.Writeonly.Definition
+ summary: Defines write-only data operations.
+ example: []
syntax:
content: 'public interface IWriteOnlyDataHandler where TEntity : WriteOnlyEntity'
typeParameters:
- id: TEntity
+ description: Type of entity
content.vb: Public Interface IWriteOnlyDataHandler(Of TEntity As WriteOnlyEntity)
nameWithType.vb: IWriteOnlyDataHandler(Of TEntity)
fullName.vb: Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler(Of TEntity)
@@ -51,19 +54,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: CreateItemAsync
path: ../src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
- startLine: 4
+ startLine: 14
assemblies:
- Quickie
namespace: Quickie.DataHandlers.Writeonly.Definition
+ summary: Create an item
+ example: []
syntax:
content: Task> CreateItemAsync(TEntity item, CancellationToken? cancellationToken)
parameters:
- id: item
type: '{TEntity}'
+ description: Data to create
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{{TEntity}}}
+ description: Response object
content.vb: Function CreateItemAsync(item As TEntity, cancellationToken As CancellationToken?) As Task(Of ResponseObj(Of TEntity))
overload: Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler`1.CreateItemAsync*
nameWithType.vb: IWriteOnlyDataHandler(Of TEntity).CreateItemAsync(TEntity, CancellationToken?)
@@ -86,19 +94,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: CreateItemsAsync
path: ../src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
- startLine: 5
+ startLine: 22
assemblies:
- Quickie
namespace: Quickie.DataHandlers.Writeonly.Definition
+ summary: Create collection of data
+ example: []
syntax:
content: Task>> CreateItemsAsync(ICollection items, CancellationToken? cancellationToken)
parameters:
- id: items
type: System.Collections.Generic.ICollection{{TEntity}}
+ description: Collection of data or items to create
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{System.Collections.Generic.ICollection{{TEntity}}}}
+ description: Response object
content.vb: Function CreateItemsAsync(items As ICollection(Of TEntity), cancellationToken As CancellationToken?) As Task(Of ResponseObj(Of ICollection(Of TEntity)))
overload: Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler`1.CreateItemsAsync*
nameWithType.vb: IWriteOnlyDataHandler(Of TEntity).CreateItemsAsync(ICollection(Of TEntity), CancellationToken?)
diff --git a/docs/api/Quickie.DataHandlers.Writeonly.Definition.html b/docs/api/Quickie.DataHandlers.Writeonly.Definition.html
index 5ab255a..6ec476d 100644
--- a/docs/api/Quickie.DataHandlers.Writeonly.Definition.html
+++ b/docs/api/Quickie.DataHandlers.Writeonly.Definition.html
@@ -103,7 +103,8 @@
- IWriteOnlyDataHandler<TEntity>
-
+ Defines write-only data operations.
+
diff --git a/docs/api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.html b/docs/api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.html
index c2e6ebd..99986f1 100644
--- a/docs/api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.html
+++ b/docs/api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.html
@@ -6,7 +6,7 @@
-
+
@@ -96,7 +96,7 @@ Table of Contents
-Interface ICrudForCollectionRequestHandler<TViewModel, TIdType>
+Interface ICrudForCollectionRequestHandler<TViewModel, TIdType>
@@ -104,7 +104,8 @@
AssemblyQuickie.dll
-
+ Abstract base class for handling collections of CRUD requests (or CRUD for collection object).
+
@@ -116,7 +117,8 @@
Type Parameters
TViewModel
-
+ Type of view model that represents the data transfer object for collection of CRUD operations.
+
TIdType
@@ -138,10 +140,11 @@ Methods
CountAsync(CancellationToken?)
-
+
-
+ Get total count of data
+
@@ -151,13 +154,15 @@
Parameters
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj<int>>
-
+ Response object
+
@@ -174,10 +179,11 @@ Returns
CreateRangeAsync(ICollection<TViewModel>, CancellationToken?)
-
+
-
+
@@ -187,15 +193,18 @@
Parameters
entities ICollection<TViewModel>
-
+ Requested collection of data to be created
+
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj<ICollection<TViewModel>>>
-
+ Response object
+
@@ -212,10 +221,11 @@ Returns
DeleteRangeAsync(ICollection<TIdType>, CancellationToken?)
-
+
-
+
@@ -225,15 +235,18 @@
Parameters
ids ICollection<TIdType>
-
+ Data identifier to be removed.
+
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj>
-
+ Response object
+
@@ -250,10 +263,11 @@ Returns
GetAllAsync(RequestForDataObj, CancellationToken?)
-
+
-
+
@@ -263,15 +277,18 @@
Parameters
request RequestForDataObj
-
+ Request object to filter data
+
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj<PaginatedDataObj<TViewModel>>>
-
+ Response object
+
@@ -288,10 +305,11 @@ Returns
UpdateRangeAsync(ICollection<TViewModel>, CancellationToken?)
-
+
-
+
@@ -301,15 +319,18 @@
Parameters
entities ICollection<TViewModel>
-
+ Collection of data requested to be updated
+
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj<ICollection<TViewModel>>>
-
+ Response object
+
@@ -326,7 +347,7 @@ Returns
diff --git a/docs/api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.yml b/docs/api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.yml
index 02284fd..a2eea87 100644
--- a/docs/api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.yml
+++ b/docs/api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.yml
@@ -24,15 +24,19 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: ICrudForCollectionRequestHandler
path: ../src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
- startLine: 2
+ startLine: 7
assemblies:
- Quickie
namespace: Quickie.Handlers.Crud.Definition
+ summary: Abstract base class for handling collections of CRUD requests (or CRUD for collection object).
+ example: []
syntax:
content: 'public interface ICrudForCollectionRequestHandler where TViewModel : CrudDto where TIdType : IComparable'
typeParameters:
- id: TViewModel
+ description: Type of view model that represents the data transfer object for collection of CRUD operations.
- id: TIdType
+ description: ''
content.vb: Public Interface ICrudForCollectionRequestHandler(Of TViewModel As CrudDto, TIdType As IComparable)
nameWithType.vb: ICrudForCollectionRequestHandler(Of TViewModel, TIdType)
fullName.vb: Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler(Of TViewModel, TIdType)
@@ -55,19 +59,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: CreateRangeAsync
path: ../src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
- startLine: 4
+ startLine: 15
assemblies:
- Quickie
namespace: Quickie.Handlers.Crud.Definition
+ summary: Create data in bulk.
+ example: []
syntax:
content: Task>> CreateRangeAsync(ICollection entities, CancellationToken? cancellationToken = null)
parameters:
- id: entities
type: System.Collections.Generic.ICollection{{TViewModel}}
+ description: Requested collection of data to be created
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{System.Collections.Generic.ICollection{{TViewModel}}}}
+ description: Response object
content.vb: Function CreateRangeAsync(entities As ICollection(Of TViewModel), cancellationToken As CancellationToken? = Nothing) As Task(Of ResponseObj(Of ICollection(Of TViewModel)))
overload: Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler`2.CreateRangeAsync*
nameWithType.vb: ICrudForCollectionRequestHandler(Of TViewModel, TIdType).CreateRangeAsync(ICollection(Of TViewModel), CancellationToken?)
@@ -91,19 +100,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: UpdateRangeAsync
path: ../src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
- startLine: 6
+ startLine: 23
assemblies:
- Quickie
namespace: Quickie.Handlers.Crud.Definition
+ summary: Update requested data
+ example: []
syntax:
content: Task>> UpdateRangeAsync(ICollection entities, CancellationToken? cancellationToken = null)
parameters:
- id: entities
type: System.Collections.Generic.ICollection{{TViewModel}}
+ description: Collection of data requested to be updated
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{System.Collections.Generic.ICollection{{TViewModel}}}}
+ description: Response object
content.vb: Function UpdateRangeAsync(entities As ICollection(Of TViewModel), cancellationToken As CancellationToken? = Nothing) As Task(Of ResponseObj(Of ICollection(Of TViewModel)))
overload: Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler`2.UpdateRangeAsync*
nameWithType.vb: ICrudForCollectionRequestHandler(Of TViewModel, TIdType).UpdateRangeAsync(ICollection(Of TViewModel), CancellationToken?)
@@ -127,19 +141,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: DeleteRangeAsync
path: ../src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
- startLine: 8
+ startLine: 31
assemblies:
- Quickie
namespace: Quickie.Handlers.Crud.Definition
+ summary: Removes data.
+ example: []
syntax:
content: Task DeleteRangeAsync(ICollection ids, CancellationToken? cancellationToken = null)
parameters:
- id: ids
type: System.Collections.Generic.ICollection{{TIdType}}
+ description: Data identifier to be removed.
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj}
+ description: Response object
content.vb: Function DeleteRangeAsync(ids As ICollection(Of TIdType), cancellationToken As CancellationToken? = Nothing) As Task(Of ResponseObj)
overload: Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler`2.DeleteRangeAsync*
nameWithType.vb: ICrudForCollectionRequestHandler(Of TViewModel, TIdType).DeleteRangeAsync(ICollection(Of TIdType), CancellationToken?)
@@ -163,19 +182,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: GetAllAsync
path: ../src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
- startLine: 10
+ startLine: 39
assemblies:
- Quickie
namespace: Quickie.Handlers.Crud.Definition
+ summary: Get all data
+ example: []
syntax:
content: Task>> GetAllAsync(RequestForDataObj request, CancellationToken? cancellationToken = null)
parameters:
- id: request
type: Quickie.DataObj.RequestForDataObj
+ description: Request object to filter data
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{Quickie.DataObj.PaginatedDataObj{{TViewModel}}}}
+ description: Response object
content.vb: Function GetAllAsync(request As RequestForDataObj, cancellationToken As CancellationToken? = Nothing) As Task(Of ResponseObj(Of PaginatedDataObj(Of TViewModel)))
overload: Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler`2.GetAllAsync*
nameWithType.vb: ICrudForCollectionRequestHandler(Of TViewModel, TIdType).GetAllAsync(RequestForDataObj, CancellationToken?)
@@ -198,17 +222,21 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: CountAsync
path: ../src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
- startLine: 12
+ startLine: 46
assemblies:
- Quickie
namespace: Quickie.Handlers.Crud.Definition
+ summary: Get total count of data
+ example: []
syntax:
content: Task> CountAsync(CancellationToken? cancellationToken = null)
parameters:
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{System.Int32}}
+ description: Response object
content.vb: Function CountAsync(cancellationToken As CancellationToken? = Nothing) As Task(Of ResponseObj(Of Integer))
overload: Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler`2.CountAsync*
nameWithType.vb: ICrudForCollectionRequestHandler(Of TViewModel, TIdType).CountAsync(CancellationToken?)
diff --git a/docs/api/Quickie.Handlers.Crud.Definition.html b/docs/api/Quickie.Handlers.Crud.Definition.html
index 31d0f4b..fcda158 100644
--- a/docs/api/Quickie.Handlers.Crud.Definition.html
+++ b/docs/api/Quickie.Handlers.Crud.Definition.html
@@ -103,7 +103,8 @@
- ICrudForCollectionRequestHandler<TViewModel, TIdType>
-
+ Abstract base class for handling collections of CRUD requests (or CRUD for collection object).
+
- ICrudRequestHandler<TViewModel, TIdType>
diff --git a/docs/api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.html b/docs/api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.html
index 8216ba6..d8f5dc1 100644
--- a/docs/api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.html
+++ b/docs/api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.html
@@ -6,7 +6,7 @@
-
+
@@ -96,7 +96,7 @@ Table of Contents
-Interface IWriteOnlyRequestHandler<TViewModel>
+Interface IWriteOnlyRequestHandler<TViewModel>
@@ -104,7 +104,8 @@
- Assembly
- Quickie.dll
-
+ Abstract base class for handling write only requests, processing operations for the specified view model type.
+
@@ -116,7 +117,8 @@
Type Parameters
TViewModel
-
+ The type of the view model that represents the data transfer object for WRITE-only operations.
+
@@ -136,10 +138,11 @@ Methods
CreateItemAsync(TViewModel, CancellationToken?)
-
+
-
+
@@ -149,15 +152,18 @@
Parameters
item TViewModel
-
+ Data request model to create
+
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj<TViewModel>>
-
+ Response object
+
@@ -174,10 +180,11 @@ Returns
CreateItemsAsync(ICollection<TViewModel>, CancellationToken?)
-
+
-
+
@@ -187,15 +194,18 @@
Parameters
items ICollection<TViewModel>
-
+ Data request model to create
+
cancellationToken CancellationToken?
-
+ Cancellation token
+
Returns
- Task<ResponseObj<ICollection<TViewModel>>>
-
+ Collection response object
+
@@ -212,7 +222,7 @@ Returns
diff --git a/docs/api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.yml b/docs/api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.yml
index f53f3a9..5c8e7cb 100644
--- a/docs/api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.yml
+++ b/docs/api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.yml
@@ -21,14 +21,17 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: IWriteOnlyRequestHandler
path: ../src/Quickie/Handlers/Writeonly/Definition/IWriteOnlyRequestHandler.cs
- startLine: 2
+ startLine: 6
assemblies:
- Quickie
namespace: Quickie.Handlers.Writeonly.Definition
+ summary: Abstract base class for handling write only requests, processing operations for the specified view model type.
+ example: []
syntax:
content: 'public interface IWriteOnlyRequestHandler where TViewModel : WriteOnlyDto'
typeParameters:
- id: TViewModel
+ description: The type of the view model that represents the data transfer object for WRITE-only operations.
content.vb: Public Interface IWriteOnlyRequestHandler(Of TViewModel As WriteOnlyDto)
nameWithType.vb: IWriteOnlyRequestHandler(Of TViewModel)
fullName.vb: Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler(Of TViewModel)
@@ -51,19 +54,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: CreateItemAsync
path: ../src/Quickie/Handlers/Writeonly/Definition/IWriteOnlyRequestHandler.cs
- startLine: 4
+ startLine: 14
assemblies:
- Quickie
namespace: Quickie.Handlers.Writeonly.Definition
+ summary: Create an item
+ example: []
syntax:
content: Task> CreateItemAsync(TViewModel item, CancellationToken? cancellationToken)
parameters:
- id: item
type: '{TViewModel}'
+ description: Data request model to create
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{{TViewModel}}}
+ description: Response object
content.vb: Function CreateItemAsync(item As TViewModel, cancellationToken As CancellationToken?) As Task(Of ResponseObj(Of TViewModel))
overload: Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler`1.CreateItemAsync*
nameWithType.vb: IWriteOnlyRequestHandler(Of TViewModel).CreateItemAsync(TViewModel, CancellationToken?)
@@ -86,19 +94,24 @@ items:
repo: https://github.com/sushantpt/Quickie.git
id: CreateItemsAsync
path: ../src/Quickie/Handlers/Writeonly/Definition/IWriteOnlyRequestHandler.cs
- startLine: 5
+ startLine: 22
assemblies:
- Quickie
namespace: Quickie.Handlers.Writeonly.Definition
+ summary: Create items (bulk)
+ example: []
syntax:
content: Task>> CreateItemsAsync(ICollection items, CancellationToken? cancellationToken)
parameters:
- id: items
type: System.Collections.Generic.ICollection{{TViewModel}}
+ description: Data request model to create
- id: cancellationToken
type: System.Nullable{System.Threading.CancellationToken}
+ description: Cancellation token
return:
type: System.Threading.Tasks.Task{Quickie.DataObj.ResponseObj{System.Collections.Generic.ICollection{{TViewModel}}}}
+ description: Collection response object
content.vb: Function CreateItemsAsync(items As ICollection(Of TViewModel), cancellationToken As CancellationToken?) As Task(Of ResponseObj(Of ICollection(Of TViewModel)))
overload: Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler`1.CreateItemsAsync*
nameWithType.vb: IWriteOnlyRequestHandler(Of TViewModel).CreateItemsAsync(ICollection(Of TViewModel), CancellationToken?)
diff --git a/docs/api/Quickie.Handlers.Writeonly.Definition.html b/docs/api/Quickie.Handlers.Writeonly.Definition.html
index 9708b2e..0a525ab 100644
--- a/docs/api/Quickie.Handlers.Writeonly.Definition.html
+++ b/docs/api/Quickie.Handlers.Writeonly.Definition.html
@@ -103,7 +103,8 @@
- IWriteOnlyRequestHandler<TViewModel>
-
+ Abstract base class for handling write only requests, processing operations for the specified view model type.
+
diff --git a/docs/api/toc.pdf b/docs/api/toc.pdf
index ea5fcd0..e7c8b08 100644
Binary files a/docs/api/toc.pdf and b/docs/api/toc.pdf differ
diff --git a/docs/docs/toc.pdf b/docs/docs/toc.pdf
index 31337bb..eca73f6 100644
Binary files a/docs/docs/toc.pdf and b/docs/docs/toc.pdf differ
diff --git a/docs/index.json b/docs/index.json
index 4af9114..5fbba44 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -267,12 +267,12 @@
"api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.html": {
"href": "api/Quickie.DataHandlers.Writeonly.Definition.IWriteOnlyDataHandler-1.html",
"title": "Interface IWriteOnlyDataHandler | Quickie",
- "keywords": "Interface IWriteOnlyDataHandler Namespace Quickie.DataHandlers.Writeonly.Definition Assembly Quickie.dll public interface IWriteOnlyDataHandler where TEntity : WriteOnlyEntity Type Parameters TEntity Methods CreateItemAsync(TEntity, CancellationToken?) Task> CreateItemAsync(TEntity item, CancellationToken? cancellationToken) Parameters item TEntity cancellationToken CancellationToken? Returns Task> CreateItemsAsync(ICollection, CancellationToken?) Task>> CreateItemsAsync(ICollection items, CancellationToken? cancellationToken) Parameters items ICollection cancellationToken CancellationToken? Returns Task>>"
+ "keywords": "Interface IWriteOnlyDataHandler Namespace Quickie.DataHandlers.Writeonly.Definition Assembly Quickie.dll Defines write-only data operations. public interface IWriteOnlyDataHandler where TEntity : WriteOnlyEntity Type Parameters TEntity Type of entity Methods CreateItemAsync(TEntity, CancellationToken?) Create an item Task> CreateItemAsync(TEntity item, CancellationToken? cancellationToken) Parameters item TEntity Data to create cancellationToken CancellationToken? Cancellation token Returns Task> Response object CreateItemsAsync(ICollection, CancellationToken?) Create collection of data Task>> CreateItemsAsync(ICollection items, CancellationToken? cancellationToken) Parameters items ICollection Collection of data or items to create cancellationToken CancellationToken? Cancellation token Returns Task>> Response object"
},
"api/Quickie.DataHandlers.Writeonly.Definition.html": {
"href": "api/Quickie.DataHandlers.Writeonly.Definition.html",
"title": "Namespace Quickie.DataHandlers.Writeonly.Definition | Quickie",
- "keywords": "Namespace Quickie.DataHandlers.Writeonly.Definition Interfaces IWriteOnlyDataHandler"
+ "keywords": "Namespace Quickie.DataHandlers.Writeonly.Definition Interfaces IWriteOnlyDataHandler Defines write-only data operations."
},
"api/Quickie.DataHandlers.Writeonly.Implementation.WriteOnlyDataHandler-2.html": {
"href": "api/Quickie.DataHandlers.Writeonly.Implementation.WriteOnlyDataHandler-2.html",
@@ -317,7 +317,7 @@
"api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.html": {
"href": "api/Quickie.Handlers.Crud.Definition.ICrudForCollectionRequestHandler-2.html",
"title": "Interface ICrudForCollectionRequestHandler | Quickie",
- "keywords": "Interface ICrudForCollectionRequestHandler Namespace Quickie.Handlers.Crud.Definition Assembly Quickie.dll public interface ICrudForCollectionRequestHandler where TViewModel : CrudDto where TIdType : IComparable Type Parameters TViewModel TIdType Methods CountAsync(CancellationToken?) Task> CountAsync(CancellationToken? cancellationToken = null) Parameters cancellationToken CancellationToken? Returns Task> CreateRangeAsync(ICollection, CancellationToken?) Task>> CreateRangeAsync(ICollection entities, CancellationToken? cancellationToken = null) Parameters entities ICollection cancellationToken CancellationToken? Returns Task>> DeleteRangeAsync(ICollection, CancellationToken?) Task DeleteRangeAsync(ICollection ids, CancellationToken? cancellationToken = null) Parameters ids ICollection cancellationToken CancellationToken? Returns Task GetAllAsync(RequestForDataObj, CancellationToken?) Task>> GetAllAsync(RequestForDataObj request, CancellationToken? cancellationToken = null) Parameters request RequestForDataObj cancellationToken CancellationToken? Returns Task>> UpdateRangeAsync(ICollection, CancellationToken?) Task>> UpdateRangeAsync(ICollection entities, CancellationToken? cancellationToken = null) Parameters entities ICollection cancellationToken CancellationToken? Returns Task>>"
+ "keywords": "Interface ICrudForCollectionRequestHandler Namespace Quickie.Handlers.Crud.Definition Assembly Quickie.dll Abstract base class for handling collections of CRUD requests (or CRUD for collection object). public interface ICrudForCollectionRequestHandler where TViewModel : CrudDto where TIdType : IComparable Type Parameters TViewModel Type of view model that represents the data transfer object for collection of CRUD operations. TIdType Methods CountAsync(CancellationToken?) Get total count of data Task> CountAsync(CancellationToken? cancellationToken = null) Parameters cancellationToken CancellationToken? Cancellation token Returns Task> Response object CreateRangeAsync(ICollection, CancellationToken?) Create data in bulk. Task>> CreateRangeAsync(ICollection entities, CancellationToken? cancellationToken = null) Parameters entities ICollection Requested collection of data to be created cancellationToken CancellationToken? Cancellation token Returns Task>> Response object DeleteRangeAsync(ICollection, CancellationToken?) Removes data. Task DeleteRangeAsync(ICollection ids, CancellationToken? cancellationToken = null) Parameters ids ICollection Data identifier to be removed. cancellationToken CancellationToken? Cancellation token Returns Task Response object GetAllAsync(RequestForDataObj, CancellationToken?) Get all data Task>> GetAllAsync(RequestForDataObj request, CancellationToken? cancellationToken = null) Parameters request RequestForDataObj Request object to filter data cancellationToken CancellationToken? Cancellation token Returns Task>> Response object UpdateRangeAsync(ICollection, CancellationToken?) Update requested data Task>> UpdateRangeAsync(ICollection entities, CancellationToken? cancellationToken = null) Parameters entities ICollection Collection of data requested to be updated cancellationToken CancellationToken? Cancellation token Returns Task>> Response object"
},
"api/Quickie.Handlers.Crud.Definition.ICrudRequestHandler-2.html": {
"href": "api/Quickie.Handlers.Crud.Definition.ICrudRequestHandler-2.html",
@@ -327,7 +327,7 @@
"api/Quickie.Handlers.Crud.Definition.html": {
"href": "api/Quickie.Handlers.Crud.Definition.html",
"title": "Namespace Quickie.Handlers.Crud.Definition | Quickie",
- "keywords": "Namespace Quickie.Handlers.Crud.Definition Interfaces ICrudForCollectionRequestHandler ICrudRequestHandler Abstract base class for CRUD operation. Contains method to: Create, Update, Read (GET), and Delete."
+ "keywords": "Namespace Quickie.Handlers.Crud.Definition Interfaces ICrudForCollectionRequestHandler Abstract base class for handling collections of CRUD requests (or CRUD for collection object). ICrudRequestHandler Abstract base class for CRUD operation. Contains method to: Create, Update, Read (GET), and Delete."
},
"api/Quickie.Handlers.Crud.Implementation.CrudForCollectionRequestHandler-4.html": {
"href": "api/Quickie.Handlers.Crud.Implementation.CrudForCollectionRequestHandler-4.html",
@@ -417,12 +417,12 @@
"api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.html": {
"href": "api/Quickie.Handlers.Writeonly.Definition.IWriteOnlyRequestHandler-1.html",
"title": "Interface IWriteOnlyRequestHandler | Quickie",
- "keywords": "Interface IWriteOnlyRequestHandler Namespace Quickie.Handlers.Writeonly.Definition Assembly Quickie.dll public interface IWriteOnlyRequestHandler where TViewModel : WriteOnlyDto Type Parameters TViewModel Methods CreateItemAsync(TViewModel, CancellationToken?) Task> CreateItemAsync(TViewModel item, CancellationToken? cancellationToken) Parameters item TViewModel cancellationToken CancellationToken? Returns Task> CreateItemsAsync(ICollection, CancellationToken?) Task>> CreateItemsAsync(ICollection items, CancellationToken? cancellationToken) Parameters items ICollection cancellationToken CancellationToken? Returns Task>>"
+ "keywords": "Interface IWriteOnlyRequestHandler Namespace Quickie.Handlers.Writeonly.Definition Assembly Quickie.dll Abstract base class for handling write only requests, processing operations for the specified view model type. public interface IWriteOnlyRequestHandler where TViewModel : WriteOnlyDto Type Parameters TViewModel The type of the view model that represents the data transfer object for WRITE-only operations. Methods CreateItemAsync(TViewModel, CancellationToken?) Create an item Task> CreateItemAsync(TViewModel item, CancellationToken? cancellationToken) Parameters item TViewModel Data request model to create cancellationToken CancellationToken? Cancellation token Returns Task> Response object CreateItemsAsync(ICollection, CancellationToken?) Create items (bulk) Task>> CreateItemsAsync(ICollection items, CancellationToken? cancellationToken) Parameters items ICollection Data request model to create cancellationToken CancellationToken? Cancellation token Returns Task>> Collection response object"
},
"api/Quickie.Handlers.Writeonly.Definition.html": {
"href": "api/Quickie.Handlers.Writeonly.Definition.html",
"title": "Namespace Quickie.Handlers.Writeonly.Definition | Quickie",
- "keywords": "Namespace Quickie.Handlers.Writeonly.Definition Interfaces IWriteOnlyRequestHandler"
+ "keywords": "Namespace Quickie.Handlers.Writeonly.Definition Interfaces IWriteOnlyRequestHandler Abstract base class for handling write only requests, processing operations for the specified view model type."
},
"api/Quickie.Handlers.Writeonly.Implementation.WriteOnlyRequestHandler-3.html": {
"href": "api/Quickie.Handlers.Writeonly.Implementation.WriteOnlyRequestHandler-3.html",
diff --git a/docs/manifest.json b/docs/manifest.json
index fc802ba..6899c6d 100644
--- a/docs/manifest.json
+++ b/docs/manifest.json
@@ -1686,6 +1686,16 @@
},
"version": ""
},
+ {
+ "type": "Resource",
+ "source_relative_path": "images/nugeticon.png",
+ "output": {
+ "resource": {
+ "relative_path": "images/nugeticon.png"
+ }
+ },
+ "version": ""
+ },
{
"type": "Resource",
"source_relative_path": "images/quickie_icon.png",
diff --git a/docs/public/main.js b/docs/public/main.js
index 3fe39c4..24680f3 100644
--- a/docs/public/main.js
+++ b/docs/public/main.js
@@ -9,6 +9,11 @@ export default {
icon: 'github',
href: 'https://github.com/sushantpt/Quickie',
title: 'GitHub'
+ },
+ {
+ icon: 'download',
+ href: 'https://www.nuget.org/packages/Quickie',
+ title: 'NuGet'
}
]
}
diff --git a/docs/template/public/main.js b/docs/template/public/main.js
index 3fe39c4..24680f3 100644
--- a/docs/template/public/main.js
+++ b/docs/template/public/main.js
@@ -9,6 +9,11 @@ export default {
icon: 'github',
href: 'https://github.com/sushantpt/Quickie',
title: 'GitHub'
+ },
+ {
+ icon: 'download',
+ href: 'https://www.nuget.org/packages/Quickie',
+ title: 'NuGet'
}
]
}
diff --git a/docs/toc.pdf b/docs/toc.pdf
index 8107b57..8d2be45 100644
Binary files a/docs/toc.pdf and b/docs/toc.pdf differ
diff --git a/images/rocket-svgrepo-com.svg b/images/rocket-svgrepo-com.svg
new file mode 100644
index 0000000..0bc6166
--- /dev/null
+++ b/images/rocket-svgrepo-com.svg
@@ -0,0 +1,7 @@
+
+
+
\ No newline at end of file
diff --git a/sample/sample.apis/sample.apis.csproj b/sample/sample.apis/sample.apis.csproj
index 671ee8e..9b08e6f 100644
--- a/sample/sample.apis/sample.apis.csproj
+++ b/sample/sample.apis/sample.apis.csproj
@@ -7,10 +7,10 @@
-
-
-
-
+
+
+
+
diff --git a/sample/sample.idempotent.redis/sample.idempotent.redis.csproj b/sample/sample.idempotent.redis/sample.idempotent.redis.csproj
index f11b5cc..3003c11 100644
--- a/sample/sample.idempotent.redis/sample.idempotent.redis.csproj
+++ b/sample/sample.idempotent.redis/sample.idempotent.redis.csproj
@@ -7,9 +7,9 @@
-
-
-
+
+
+
diff --git a/sample/sample.minimalapi/sample.minimalapi.csproj b/sample/sample.minimalapi/sample.minimalapi.csproj
index 1876911..ec3b86b 100644
--- a/sample/sample.minimalapi/sample.minimalapi.csproj
+++ b/sample/sample.minimalapi/sample.minimalapi.csproj
@@ -8,8 +8,8 @@
-
-
+
+
diff --git a/sample/sample2.Todos/sample2.Todos.csproj b/sample/sample2.Todos/sample2.Todos.csproj
index 67ad98d..7b8303e 100644
--- a/sample/sample2.Todos/sample2.Todos.csproj
+++ b/sample/sample2.Todos/sample2.Todos.csproj
@@ -8,9 +8,9 @@
-
-
-
+
+
+
diff --git a/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs b/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
index cb285a1..f74cc8d 100644
--- a/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
+++ b/src/Quickie/DataHandlers/Writeonly/Definition/IWriteOnlyDataHandler.cs
@@ -1,7 +1,24 @@
namespace Quickie.DataHandlers.Writeonly.Definition;
+///
+/// Defines write-only data operations.
+///
+/// Type of entity
public interface IWriteOnlyDataHandler where TEntity : WriteOnlyEntity
{
+ ///
+ /// Create an item
+ ///
+ /// Data to create
+ /// Cancellation token
+ /// Response object
Task> CreateItemAsync(TEntity item, CancellationToken? cancellationToken);
+
+ ///
+ /// Create collection of data
+ ///
+ /// Collection of data or items to create
+ /// Cancellation token
+ /// Response object
Task>> CreateItemsAsync(ICollection items, CancellationToken? cancellationToken);
}
\ No newline at end of file
diff --git a/src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs b/src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
index 338a48a..091bd41 100644
--- a/src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
+++ b/src/Quickie/Handlers/Crud/Definition/ICrudForCollectionRequestHandler.cs
@@ -1,14 +1,48 @@
namespace Quickie.Handlers.Crud.Definition;
+///
+/// Abstract base class for handling collections of CRUD requests (or CRUD for collection object).
+///
+/// Type of view model that represents the data transfer object for collection of CRUD operations.
+///
public interface ICrudForCollectionRequestHandler where TViewModel : CrudDto where TIdType : IComparable
{
+ ///
+ /// Create data in bulk.
+ ///
+ /// Requested collection of data to be created
+ /// Cancellation token
+ /// Response object
Task>> CreateRangeAsync(ICollection entities, CancellationToken? cancellationToken = default);
+ ///
+ /// Update requested data
+ ///
+ /// Collection of data requested to be updated
+ /// Cancellation token
+ /// Response object
Task>> UpdateRangeAsync(ICollection entities, CancellationToken? cancellationToken = default);
+ ///
+ /// Removes data.
+ ///
+ /// Data identifier to be removed.
+ /// Cancellation token
+ /// Response object
Task DeleteRangeAsync(ICollection ids, CancellationToken? cancellationToken = default);
+ ///
+ /// Get all data
+ ///
+ /// Request object to filter data
+ /// Cancellation token
+ /// Response object
Task>> GetAllAsync(RequestForDataObj request, CancellationToken? cancellationToken = default);
+ ///
+ /// Get total count of data
+ ///
+ /// Cancellation token
+ /// Response object
Task> CountAsync(CancellationToken? cancellationToken = default);
}
\ No newline at end of file
diff --git a/src/Quickie/Handlers/Writeonly/Definition/IWriteOnlyRequestHandler.cs b/src/Quickie/Handlers/Writeonly/Definition/IWriteOnlyRequestHandler.cs
index 2e66daf..71410a1 100644
--- a/src/Quickie/Handlers/Writeonly/Definition/IWriteOnlyRequestHandler.cs
+++ b/src/Quickie/Handlers/Writeonly/Definition/IWriteOnlyRequestHandler.cs
@@ -1,7 +1,24 @@
namespace Quickie.Handlers.Writeonly.Definition;
+///
+/// Abstract base class for handling write only requests, processing operations for the specified view model type.
+///
+/// The type of the view model that represents the data transfer object for WRITE-only operations.
public interface IWriteOnlyRequestHandler where TViewModel : WriteOnlyDto
{
+ ///
+ /// Create an item
+ ///
+ /// Data request model to create
+ /// Cancellation token
+ /// Response object
Task> CreateItemAsync(TViewModel item, CancellationToken? cancellationToken);
+
+ ///
+ /// Create items (bulk)
+ ///
+ /// Data request model to create
+ /// Cancellation token
+ /// Collection response object
Task>> CreateItemsAsync(ICollection items, CancellationToken? cancellationToken);
}
\ No newline at end of file
diff --git a/src/Quickie/Quickie.csproj b/src/Quickie/Quickie.csproj
index 57813cc..7f70ce7 100644
--- a/src/Quickie/Quickie.csproj
+++ b/src/Quickie/Quickie.csproj
@@ -1,7 +1,7 @@
- 1.2.0
+ 1.2.1
net9.0
enable
enable
@@ -13,7 +13,7 @@
https://github.com/sushantpt/Quickie
git
api, backend, web
- Updated internal dependencies, enabled documentation on hover for better dev experience.
+ Updated internal dependencies, added doc comment etc.
true
quickie_icon.png
true
@@ -22,9 +22,9 @@
-
-
-
+
+
+
diff --git a/tests/specification/specification.csproj b/tests/specification/specification.csproj
index 486a7ce..4059f26 100644
--- a/tests/specification/specification.csproj
+++ b/tests/specification/specification.csproj
@@ -8,12 +8,11 @@
-
-
-
+
+
-
-
+
+
all
runtime; build; native; contentfiles; analyzers; buildtransitive