Skip to content

collection/client

collection/client

Functions

collectionPageRows()

function collectionPageRows<TRow>(query): CollectionPageQuery<TRow>;

Defined in: platform-utils/src/collection/client.ts:15

Type Parameters

Type Parameter
TRow extends object

Parameters

Parameter Type
query RemoteQuery<CollectionPage<TRow>>

Returns

CollectionPageQuery<TRow>


createCollectionClient()

function createCollectionClient<TCollections>(
   collections, 
   transport, 
extensions?): CollectionClient<TCollections>;

Defined in: platform-utils/src/collection/client.ts:52

Type Parameters

Type Parameter
TCollections extends Readonly<Record<string, CollectionType<object, object, object>>>

Parameters

Parameter Type
collections { readonly [TName in string | number | symbol]: CollectionDefinition<TCollections[TName]> }
transport CollectionTransport
extensions? Pick<CollectionClient<TCollections>, "approvals">

Returns

CollectionClient<TCollections>