Skip to main content

Function: getFile()

getFile<T>(client, props, binaryResponse?): Promise<BinaryResponseType<T>>

Gets a storage file as binary data.

Type Parameters​

T​

T extends BinaryResponse

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ oid: string; } = fileParamsSchema

Path parameters (oid)

params.oid​

string = ...

query?​

{ name?: string; } = ...

Query parameters (name)

query.name?​

string = ...

binaryResponse?​

T = ...

Optional binary response type configuration

Returns​

Promise<BinaryResponseType<T>>

Promise resolving to the file binary data

Operation Id​

get-file

Example​

const file = await getFile(client, {
  params: { oid: 'abc123...' },
  query: { name: 'my-asset' }
});