Class Generate

Represents a class for generating avatars.

Hierarchy (view full)

BaseRoot
- Generate

Index

Constructors

Properties

Methods

generate getApiKeys makeRequest

Constructors

constructor

new Generate(client): Generate
Constructs a new instance of the Generate class.
Parameters
- client: Client
  The client object.
Returns Generate
Overrides BaseRoot.constructor
- Defined in src/v2/Generate.ts:15

Properties

client

client: Client

The client used to make requests.

Methods

generate

generate(text?, color?, size?, font?): Promise<any>
Generates an avatar with the specified parameters.
Parameters
- text: string = "Niz"
  The text to be displayed on the avatar.
- Optional color: string
  The background color of the avatar.
- Optional size: number
  The size of the avatar.
- Optional font: GayFont
  The font settings for the text on the avatar.
Returns Promise<any>
- The generated avatar.
- Defined in src/v2/Generate.ts:29

getApiKeys

getApiKeys(): ApiKeys
Gets the API keys.

Returns ApiKeys
The API keys.
Inherited from BaseRoot.getApiKeys
- Defined in src/BaseRoot.ts:26

makeRequest

makeRequest(endpoint, data?): Promise<any>
Makes an HTTP request to the specified endpoint.
Parameters
- endpoint: string
  The endpoint to make the request to.
- Optional data: any
  The data to send with the request (optional).
Returns Promise<any>
A Promise that resolves to the response data.

Throws
If the request fails.
Inherited from BaseRoot.makeRequest
- Defined in src/Requester.ts:24

Generated using TypeDoc