@ultirequiem/tixte
    Preparing search index...

    Class TixteClient

    Client for interacting with the Tixte API

    Index
    • Creates a new TixteClient instance

      Parameters

      • apiKey: string

        Your Tixte API key for authentication

      • Optionaloptions: { defaultURL?: string }

        Optional configuration options

      Returns TixteClient

    • Updates information for an existing file

      Parameters

      • id: string | number

        The file ID or asset ID to update

      • fileInfo: UpdateFileInfo

        Object containing the fields to update (name, extension)

      Returns Promise<UpdateFileResponse>

      Promise resolving to update response with updated file details

    • Uploads a file to Tixte

      Parameters

      • buffer: ArrayBuffer | Uint8Array<ArrayBufferLike> | Blob

        The file data as a Uint8Array, ArrayBuffer or Blob

      • options: UploadOptions = {}

        Upload options including extension, filename, and domain

      Returns Promise<UploadFileResponse>

      Promise resolving to upload response with file details

      Error if no domain is provided and no default URL is set

    • Lists uploaded files with pagination

      Parameters

      • page: number = 1

        Page number to retrieve (default: 1)

      • amount: number = 3

        Number of uploads per page (default: 3)

      Returns Promise<UploadsResponse>

      Promise resolving to uploads list with pagination info