UNPKG

@clerk/backend

Version:

Clerk Backend SDK - REST Client for Backend API & JWT verification utilities

26 lines 1.27 kB
type ResourceResponse<T> = { /** * An array that contains the fetched data. */ data: T; }; /** * An interface that describes the response of a method that returns a paginated list of resources. * * If the promise resolves, you will get back the [properties](#properties) listed below. `data` will be an array of the resource type you requested. You can use the `totalCount` property to determine how many total items exist remotely. * * Some methods that return this type allow pagination with the `limit` and `offset` parameters, in which case the first 10 items will be returned by default. For methods such as [`getAllowlistIdentifierList()`](https://clerk.com/docs/reference/backend/allowlist/get-allowlist-identifier-list), which do not take a `limit` or `offset`, all items will be returned. * * If the promise is rejected, you will receive a `ClerkAPIResponseError` or network error. * * @interface */ export type PaginatedResourceResponse<T> = ResourceResponse<T> & { /** * The total count of data that exist remotely. */ totalCount: number; }; export declare function deserialize<U = any>(payload: unknown): PaginatedResourceResponse<U> | ResourceResponse<U>; export {}; //# sourceMappingURL=Deserializer.d.ts.map