Class Uploads<PF>

constructor

• new Uploads<PF extends PostFormatOptions = NoV2Options>(
      e621: E621<PF> | undefined,
      client: Client,
  ): Uploads<PF>

  e621 may be omitted (pass undefined) when constructing a module standalone, without the main E621 client, to keep bundles tree-shakable. Convenience methods on models returned by this module that call back into other modules via this.e621 will throw in that case.

  Type Parameters

  • PF extends PostFormatOptions = NoV2Options

  Parameters

  • e621: E621<PF> | undefined
  • client: Client

  Returns Uploads<PF>

Static ReadonlymoduleKey

create

• create(
      options: UploadPostOptions,
      waitOptions?: WaitForUploadOptions,
  ): Promise<PostFormat<PF["v2"], PF["mode"]>>
  Requires Api Key Auth

  Uploads are processed asynchronously, if the upload isn't finished right away this waits for it (see Uploads.wait).

  Parameters

  • options: UploadPostOptions
  • OptionalwaitOptions: WaitForUploadOptions

  Returns Promise<PostFormat<PF["v2"], PF["mode"]>>

  Operation Id

  uploads#create

  See

  Documentation for more details.

get

• get(id: number): Promise<Upload | null>

  You must be the uploader, or Staff+. Can be polled while an upload is processing.

  Parameters

  • id: number

  Returns Promise<Upload | null>

  Operation Id

  uploads#show

  See

  Documentation for more details.

search

• search(options?: SearchUploadsOptions): Promise<Upload[]>

  Parameters

  • Optionaloptions: SearchUploadsOptions

  Returns Promise<Upload[]>

  Operation Id

  uploads#index

  See

  Documentation for more details.

wait

• wait(id: number, options?: WaitForUploadOptions): Promise<Upload>

  You must be the uploader, or Staff+. Can be polled while an upload is processing.

  Parameters

  • id: number
  • Optionaloptions: WaitForUploadOptions

  Returns Promise<Upload>

  Operation Id

  uploads#show

  See

  Documentation for more details.