Class Rest

The Rest service provides functionality for interacting with the FakeYou API and handles authentication.

Index

Constructors

Properties

Accessors

cookie isAuthenticated

Methods

download send upload

Constructors

constructor

new Rest(): Rest
Returns Rest

Properties

`Private` `Optional` #cookie

#cookie?: string = process.env.FAKEYOU_COOKIE

Accessors

cookie

set cookie(cookie): void
Set the cookie to use for authentication.
Parameters
- cookie: undefined | string
Returns void
- Defined in src/services/rest/Rest.ts:106

isAuthenticated

get isAuthenticated(): boolean
Authentication status.

Returns boolean
Whether or not the user is authenticated.
- Defined in src/services/rest/Rest.ts:115

Methods

download

download(url, mime): Promise<undefined | Buffer>
Download a file from the given URL.
Parameters
- url: string
  The URL to download from.
- mime: string
  The mime type of the file.
Returns Promise<undefined | Buffer>
- Defined in src/services/rest/Rest.ts:49

send

send(url, request?): Promise<Response>
Light wrapper over fetch, provides authentication and logging automatically. The correct headers are automatically set to comply with the FakeYou API.

Note: If FAKEYOU_COOKIE environment variable is set, it will be used for authentication.
Parameters
- url: string
  The URL to send the request to.
- Optional request: RequestInit
  The request options to send.
Returns Promise<Response>
- Defined in src/services/rest/Rest.ts:18

upload

upload(url, data, mime): Promise<Response>
Upload a file to the given URL.
Parameters
- url: string
  The URL to upload to.
- data: Buffer
  The data to upload as a buffer.
- mime: string
  The mime type of the file.
Returns Promise<Response>
The response from the server.
- Defined in src/services/rest/Rest.ts:86

Generated using TypeDoc