core-data-layer
v0.0.15arrow_drop_down@rentops/frontend
- HttpResponse
- ICoreCudItemsDataReturn
- ICoreDataContext
- ICoreGetItemDataReturn
- ICoreGetItemsDataReturn
- ICountMeta
- IExtendedCoreContext
- IGenericNameId
- IGenericNameValue
- INodeBrickErrorResponse
- INormalisedEntity
- IPaginationMeta
- IUseCoreCudItemsParam
- IUseCoreGetItemParam
- IUseCoreGetItemsParam
- IUseCoreOptions
- IUseCorePaginationParams
- IUseCorePaginationReturn
Type aliases
Variables
Functions
- headerWithAccessToken
- mergeCollectionByCRMEntityUuid
- mergeCollectionByKey
- mergeCollectionByUuid
- useCoreCudItem
- useCoreCudItems
- useCoreGetItems
- useCorePagination
Type aliases
HexRGB
F, HexRGB: string
Defined in: src/libs/core-data-layer/types/core.ts:2
ProgressValue
F, ProgressValue: typeof Progress[keyof typeof Progress]
Defined in: src/libs/core-data-layer/types/progress.ts:7
RFC3339DateString
F, RFC3339DateString: string
Defined in: src/libs/core-data-layer/types/core.ts:3
UUID
F, UUID: string
Defined in: src/libs/core-data-layer/types/core.ts:1
Variables
Progress
b " Const
Progress: object
Type declaration:
Name | Type |
---|---|
FULFILLED | string |
IDLE | string |
PENDING | string |
REJECTED | string |
Defined in: src/libs/core-data-layer/types/progress.ts:1
Functions
headerWithAccessToken
b8 Const
headerWithAccessToken(accessToken
: string): object
Parameters:
Name | Type |
---|---|
accessToken | string |
Returns: object
Name | Type |
---|---|
headers | any |
Defined in: src/libs/core-data-layer/libs/headers.tsx:3
mergeCollectionByCRMEntityUuid
b8 mergeCollectionByCRMEntityUuid<T>(arr1
: T[], arr2
: T[]): T[]
Type parameters:
Name | Type |
---|---|
T | unknown |
Parameters:
Name | Type |
---|---|
arr1 | T[] |
arr2 | T[] |
Returns: T[]
Defined in: src/libs/core-data-layer/libs/merge-collection-by.ts:26
mergeCollectionByKey
b8 mergeCollectionByKey<T>(arr1
: T[], arr2
: T[], key
: string): T[]
Type parameters:
Name | Type |
---|---|
T | unknown |
Parameters:
Name | Type |
---|---|
arr1 | T[] |
arr2 | T[] |
key | string |
Returns: T[]
Defined in: src/libs/core-data-layer/libs/merge-collection-by.ts:1
mergeCollectionByUuid
b8 mergeCollectionByUuid<T>(arr1
: T[], arr2
: T[]): T[]
Type parameters:
Name | Type |
---|---|
T | unknown |
Parameters:
Name | Type |
---|---|
arr1 | T[] |
arr2 | T[] |
Returns: T[]
Defined in: src/libs/core-data-layer/libs/merge-collection-by.ts:22
useCoreCudItem
b8 useCoreCudItem<Item, SWRKeyName, CreateItem, UpdateItem>(params
: IUseCoreGetItemParam<SWRKeyName>): ICoreGetItemDataReturn<Item, SWRKeyName>
Type parameters:
Name | Type | Default | Description |
---|---|---|---|
Item | - | - | The main model type you are passing |
SWRKeyName | string | ** | Used for revalidation of calls |
CreateItem | unknown | {} | |
UpdateItem | unknown | {} |
Parameters:
Name | Type |
---|---|
params | IUseCoreGetItemParam<SWRKeyName> |
Returns: ICoreGetItemDataReturn<Item, SWRKeyName>
Defined in: src/libs/core-data-layer/hooks/use-core-get-item.tsx:39
useCoreCudItems
b8 useCoreCudItems<Item, SWRKeyName, CreateItem, UpdateItem>(params
: IUseCoreCudItemsParam<SWRKeyName>): ICoreCudItemsDataReturn<Item, SWRKeyName, CreateItem, UpdateItem>
Type parameters:
Name | Type | Default | Description |
---|---|---|---|
Item | - | - | The main model type you are passing |
SWRKeyName | string | ** | Used for revalidation of calls |
CreateItem | unknown | {} | |
UpdateItem | unknown | {} |
Parameters:
Name | Type |
---|---|
params | IUseCoreCudItemsParam<SWRKeyName> |
Returns: ICoreCudItemsDataReturn<Item, SWRKeyName, CreateItem, UpdateItem>
Defined in: src/libs/core-data-layer/hooks/use-core-cud-items.tsx:42
useCoreGetItems
b8 useCoreGetItems<Item, SWRKeyName>(__namedParameters
: IUseCoreGetItemsParam<SWRKeyName>): ICoreGetItemsDataReturn<Item>
Type parameters:
Name | Type | Default | Description |
---|---|---|---|
Item | - | - | The main model type you are passing |
SWRKeyName | string | ** | Used for revalidation of calls |
Parameters:
Name | Type |
---|---|
__namedParameters | IUseCoreGetItemsParam<SWRKeyName> |
Returns: ICoreGetItemsDataReturn<Item>
Defined in: src/libs/core-data-layer/hooks/use-core-get-items.tsx:37
useCorePagination
b8 useCorePagination<Entity>(params
: IUseCorePaginationParams): IUseCorePaginationReturn<Entity>
Type parameters:
Name | Default |
---|---|
Entity | any |
Parameters:
Name | Type |
---|---|
params | IUseCorePaginationParams |
Returns: IUseCorePaginationReturn<Entity>
Defined in: src/libs/core-data-layer/hooks/use-core-pagination.tsx:30