Class TixteClient

Hierarchy

TixteClient

Index

Constructors

constructor

Methods

Constructors

constructor

new TixteClient(apiKey: string, options?: { defaultURL?: string }): TixteClient

- Defined in client.ts:26
Parameters
- apiKey: string
- Optional options: { defaultURL?: string }
  - Optional defaultURL?: string
Returns TixteClient

Methods

accountInfo

accountInfo(): Promise<AccountDetails>

- Defined in client.ts:36
Gets account details of user

Returns Promise<AccountDetails>

deleteFile

deleteFile(id: string | number): Promise<DeleteFileResponse>

- Defined in client.ts:112
Parameters
- id: string | number
Returns Promise<DeleteFileResponse>

domains

domains(): Promise<AccountDetails>

- Defined in client.ts:47
Gets all domains registered by user

Returns Promise<AccountDetails>

size

size(): Promise<SizeResponse>

- Defined in client.ts:58
Gets total uploaded file size of user

Returns Promise<SizeResponse>

updateFile

updateFile<T>(id: string | number, fileInfo: T): Promise<UploadFileResponse>

- Defined in client.ts:92
Type parameters
- T
Parameters
- id: string | number
- fileInfo: T
Returns Promise<UploadFileResponse>

uploadFile

uploadFile(buffer: Uint8Array, options?: UploadOptions): Promise<UploadFileResponse>

- Defined in client.ts:63
Parameters
- buffer: Uint8Array
- options: UploadOptions = {}
Returns Promise<UploadFileResponse>

uploads

uploads(page?: number, amount?: number): Promise<Record<string, any>>

- Defined in client.ts:101
Parameters
- page: number = 1
- amount: number = 3
Returns Promise<Record<string, any>>

Generated using TypeDoc