node-zendesk / Exports / clients/endpoint-checker / EndpointChecker

Class: EndpointChecker

clients/endpoint-checker.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.

Table of contents

Constructors

• constructor

Properties

• SUPPORTED_ENDPOINTS
• SUPPORTED_REGEXES
• _initSupportedRegexes

Methods

• supportsCursorPagination

Constructors

constructor

• new EndpointChecker(): EndpointChecker

Returns

EndpointChecker

Properties

SUPPORTED_ENDPOINTS

• Private SUPPORTED_ENDPOINTS: any

See

https://support.zendesk.com/hc/en-us/articles/5591904358938-New-limits-for-offset-based-pagination

Defined in

clients/endpoint-checker.d.ts:15

---

SUPPORTED_REGEXES

• Private SUPPORTED_REGEXES: any

Defined in

clients/endpoint-checker.d.ts:21

---

_initSupportedRegexes

• Private _initSupportedRegexes: any

Initializes the SUPPORTED_REGEXES set by converting each endpoint in SUPPORTED_ENDPOINTS into its corresponding regex pattern.

Defined in

clients/endpoint-checker.d.ts:27

Methods

supportsCursorPagination

▸ supportsCursorPagination(endpoint): boolean

Checks if the given endpoint supports cursor pagination.

Parameters

Name	Type	Description
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