Class AbstractRequest<R>`Abstract`

Abstract class to represent requests to the Instagram Graph API.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.2.0

Type Parameters

R extends AbstractResponse<unknown>

the type of the response.

Hierarchy

AbstractRequest

Index

Constructors

Properties

apiVersion? params

Methods

addLimit addPaging addRange config execute method parseResponse url withApiVersion withLimit withPaging withRange

Constructors

`Protected` constructor

new AbstractRequest<R>(accessToken: string, apiVersion?: ApiVersion): AbstractRequest<R>
The constructor.
Type Parameters
- R extends AbstractResponse<unknown, R>
Parameters
- accessToken: string
  
  the access token.
- Optional apiVersion: ApiVersion
  
  the API version.
Returns AbstractRequest<R>
- Defined in main/requests/AbstractRequest.ts:38

Properties

`Protected` `Optional` apiVersion

apiVersion?: ApiVersion

The API Version.

`Protected` params

params: Params

The request params.

Methods

addLimit

addLimit(limit: number): void
Adds the limit param to the request.

Deprecated
since 1.7.0, use withLimit instead.
Parameters
- limit: number
  
  the number of objects to retrieve.
Returns void
- Defined in main/requests/AbstractRequest.ts:103

addPaging

addPaging(pageOptionToken: PageOptionToken): void
Adds a paging param to the request.

Deprecated
since 1.7.0, use withPaging instead.
Parameters
- pageOptionToken: PageOptionToken
  
  the page option token to create the param.
Returns void
- Defined in main/requests/AbstractRequest.ts:77

addRange

addRange(since: Date, until: Date): void
Adds the range params to the request.

Deprecated
since 1.7.0, use withRange instead.
Parameters
- since: Date
  
  the since param.
- until: Date
  
  the until param.
Returns void
- Defined in main/requests/AbstractRequest.ts:91

config

config(): RequestConfig
Builds the config of the request.

Returns
the request config.

Returns RequestConfig
- Defined in main/requests/AbstractRequest.ts:50

execute

execute(): Promise<R>
Executes the requests and returns a promise of the parsed response.

Returns
the promise of a parsed response.

Returns Promise<R>
- Defined in main/requests/AbstractRequest.ts:64

`Protected` method

method(): Method
Gets the method for the request.

Returns
the method for the request.

Returns Method
- Defined in main/requests/AbstractRequest.ts:178

`Protected` `Abstract` parseResponse

parseResponse(response: AxiosResponse<unknown>): R
Parses the response into a response object.
Parameters
- response: AxiosResponse<unknown>
  
  the parsed response.
Returns R
- Defined in main/requests/AbstractRequest.ts:164

`Protected` `Abstract` url

url(): string
Gets the url for the request.

Returns
the url for the request.

Returns string
- Defined in main/requests/AbstractRequest.ts:171

withApiVersion

withApiVersion(apiVersion: undefined | ApiVersion): AbstractRequest<R>
Sets the API version that the request will use.

Returns
this request, for use in chain invocation.
Parameters
- apiVersion: undefined | ApiVersion
  
  the API version to use.
Returns AbstractRequest<R>
- Defined in main/requests/AbstractRequest.ts:154

withLimit

withLimit(limit: number): AbstractRequest<R>
Adds the limit param to the request.

Returns
this request, for use in chain invocation.
Parameters
- limit: number
  
  the number of objects to retrieve.
Returns AbstractRequest<R>
- Defined in main/requests/AbstractRequest.ts:142

withPaging

withPaging(pageOptionToken: PageOptionToken): AbstractRequest<R>
Adds a paging param to the request.

Returns
this request, for use in chain invocation.
Parameters
- pageOptionToken: PageOptionToken
  
  the page option token to create the param.
Returns AbstractRequest<R>
- Defined in main/requests/AbstractRequest.ts:114

withRange

withRange(since: Date, until: Date): AbstractRequest<R>
Adds the range params to the request.

Returns
this request, for use in chain invocation.
Parameters
- since: Date
  
  the since param.
- until: Date
  
  the until param.
Returns AbstractRequest<R>
- Defined in main/requests/AbstractRequest.ts:129

Generated using TypeDoc