livelike logo
Product
NPM
Versions

Interface IRequestOptions

Hierarchy

  • IRequestOptions

Properties

auth? data? headers? method? path? queryParams? url?

Properties

Optional auth

auth?: string

authorization token, use createUserProfileAccessToken or createPersonalApiAccessToken API for creating authorization token

Optional data

data?: any

JSON payload data for supported http methods

Optional headers

headers?: IRequestHeaders

custom headers to be included as part of request headers

Optional method

method?: HTTP_METHOD

http method, use HTTP_METHOD enum

Optional path

path?: string

path of an endpoint eg: '/programs', '/chat-rooms/'

Optional queryParams

queryParams?: IRequestQueryParams

query params to be added to the request url (or path)

Optional url

url?: string

complete endpoint url

Settings

Member Visibility

Generated using TypeDoc