Skip to content

node-zendesk • Docs


node-zendesk / clients/endpoint-checker / EndpointChecker

Class: EndpointChecker ​

A class responsible for checking if given endpoints support cursor pagination.

This class provides utility methods to check if certain endpoints are supported based on regex patterns. It prepares and utilizes a set of regex patterns derived from a static list of endpoint strings.

Constructors ​

new EndpointChecker() ​

new EndpointChecker(): EndpointChecker

Returns ​

EndpointChecker

Methods ​

supportsCursorPagination() ​

supportsCursorPagination(endpoint): boolean

Checks if the given endpoint supports cursor pagination.

Parameters ​

• endpoint: string

The endpoint string to be checked.

Returns ​

boolean

  • Returns true if the endpoint supports cursor pagination, otherwise false.

Defined in ​

clients/endpoint-checker.d.ts:33

Released under the MIT License.