TypeScript API / laikacms/documents/jsonapi-proxy / paginationCodec

Variable: paginationCodec

const paginationCodec: object;

Pagination codec for encoding/decoding pagination parameters to/from URL query parameters following JSON:API conventions

Type Declaration

decode()

decode(params): 
  | {
  page: number;
  perPage?: number;
}
  | {
  before?: string;
  perPage?: number;
}
  | {
  after?: string;
  perPage?: number;
}
  | {
  limit?: number;
  offset: number;
};

Decode URLSearchParams to pagination object Defaults to cursor-based pagination with 'after'

Parameters

Parameter	Type
params	URLSearchParams

Returns

| { page: number; perPage?: number; } | { before?: string; perPage?: number; } | { after?: string; perPage?: number; } | { limit?: number; offset: number; }

decodeFromString()

decodeFromString(queryString): 
  | {
  page: number;
  perPage?: number;
}
  | {
  before?: string;
  perPage?: number;
}
  | {
  after?: string;
  perPage?: number;
}
  | {
  limit?: number;
  offset: number;
};

Decode query string to pagination object

Parameters

Parameter	Type
queryString	string

Returns

| { page: number; perPage?: number; } | { before?: string; perPage?: number; } | { after?: string; perPage?: number; } | { limit?: number; offset: number; }

encode()

encode(pagination): URLSearchParams;

Encode pagination object to URLSearchParams

Parameters

Parameter	Type
pagination	| { page: number; perPage?: number; } | { before?: string; perPage?: number; } | { after?: string; perPage?: number; } | { limit?: number; offset: number; }

Returns

URLSearchParams

encodeToString()

encodeToString(pagination): string;

Encode pagination to query string

Parameters

Parameter	Type
pagination	| { page: number; perPage?: number; } | { before?: string; perPage?: number; } | { after?: string; perPage?: number; } | { limit?: number; offset: number; }

Returns

string