Class S3

S3 models the shared Gestalt S3-provider protocol.

Index

Constructors

Methods

connect headObject headObjectRaw readObject readObjectRaw writeObject writeObjectRaw deleteObject deleteObjectRaw listObjects listObjectsRaw copyObject copyObjectRaw presignObject presignObjectRaw

Constructors

constructor

new S3(transport: Transport, options?: { timeoutMs?: number }): S3
Parameters
- transport: Transport
- Optionaloptions: { timeoutMs?: number }
Returns S3

Methods

`Static`connect

connect(options?: { name?: string; timeoutMs?: number }): S3
Parameters
- Optionaloptions: { name?: string; timeoutMs?: number }
Returns S3

headObject

headObject(
ref?: { key?: string; versionId?: string },
): Promise<HeadObjectResponse>
Parameters
- Optionalref: { key?: string; versionId?: string }
Returns Promise<HeadObjectResponse>

headObjectRaw

headObjectRaw(
request: { ref?: { key?: string; versionId?: string } },
): Promise<HeadObjectResponse>
Parameters
- request: { ref?: { key?: string; versionId?: string } }
Returns Promise<HeadObjectResponse>

readObject

readObject(
    request: {
        ref?: { key?: string; versionId?: string };
        range?: { start?: bigint; end?: bigint };
        ifMatch?: string;
        ifNoneMatch?: string;
        ifModifiedSince?: Date;
        ifUnmodifiedSince?: Date;
    },
): Promise<{ meta: S3ObjectMeta; data: ByteStream }>
Parameters
- request: {
      ref?: { key?: string; versionId?: string };
      range?: { start?: bigint; end?: bigint };
      ifMatch?: string;
      ifNoneMatch?: string;
      ifModifiedSince?: Date;
      ifUnmodifiedSince?: Date;
  }
Returns Promise<{ meta: S3ObjectMeta; data: ByteStream }>

readObjectRaw

readObjectRaw(
    request: {
        ref?: { key?: string; versionId?: string };
        range?: { start?: bigint; end?: bigint };
        ifMatch?: string;
        ifNoneMatch?: string;
        ifModifiedSince?: Date;
        ifUnmodifiedSince?: Date;
    },
): AsyncIterable<ReadObjectChunk>
The first response frame carries object metadata. All subsequent frames carry byte chunks. Zero-byte objects therefore emit exactly one frame.
Parameters
- request: {
      ref?: { key?: string; versionId?: string };
      range?: { start?: bigint; end?: bigint };
      ifMatch?: string;
      ifNoneMatch?: string;
      ifModifiedSince?: Date;
      ifUnmodifiedSince?: Date;
  }
Returns AsyncIterable<ReadObjectChunk>

writeObject

writeObject(
    open: {
        ref?: { key?: string; versionId?: string };
        contentType?: string;
        cacheControl?: string;
        contentDisposition?: string;
        contentEncoding?: string;
        contentLanguage?: string;
        metadata?: { [key: string]: string };
        ifMatch?: string;
        ifNoneMatch?: string;
    },
    data: AsyncIterable<Uint8Array<ArrayBufferLike>>,
): Promise<WriteObjectResponse>
Parameters
- open: {
      ref?: { key?: string; versionId?: string };
      contentType?: string;
      cacheControl?: string;
      contentDisposition?: string;
      contentEncoding?: string;
      contentLanguage?: string;
      metadata?: { [key: string]: string };
      ifMatch?: string;
      ifNoneMatch?: string;
  }
- data: AsyncIterable<Uint8Array<ArrayBufferLike>>
Returns Promise<WriteObjectResponse>

writeObjectRaw

writeObjectRaw(
    requests: AsyncIterable<
        {
            msg?: | { case: "data"; value: Uint8Array<ArrayBufferLike> }
            | { case: undefined; value?: undefined }
            | {
                case: "open";
                value: {
                    ref?: { key?: string; versionId?: string };
                    contentType?: string;
                    cacheControl?: string;
                    contentDisposition?: string;
                    contentEncoding?: string;
                    contentLanguage?: string;
                    metadata?: { [key: string]: string };
                    ifMatch?: string;
                    ifNoneMatch?: string;
                };
            };
        },
    >,
): Promise<WriteObjectResponse>
The first request frame must carry WriteObjectOpen metadata. All subsequent frames carry raw bytes. The response is emitted only after the object has been durably committed by the provider.
Parameters
- requests: AsyncIterable<
      {
          msg?: | { case: "data"; value: Uint8Array<ArrayBufferLike> }
          | { case: undefined; value?: undefined }
          | {
              case: "open";
              value: {
                  ref?: { key?: string; versionId?: string };
                  contentType?: string;
                  cacheControl?: string;
                  contentDisposition?: string;
                  contentEncoding?: string;
                  contentLanguage?: string;
                  metadata?: { [key: string]: string };
                  ifMatch?: string;
                  ifNoneMatch?: string;
              };
          };
      },
  >
Returns Promise<WriteObjectResponse>

deleteObject

deleteObject(ref?: { key?: string; versionId?: string }): Promise<void>
Parameters
- Optionalref: { key?: string; versionId?: string }
Returns Promise<void>

deleteObjectRaw

deleteObjectRaw(
request: { ref?: { key?: string; versionId?: string } },
): Promise<void>
Parameters
- request: { ref?: { key?: string; versionId?: string } }
Returns Promise<void>

listObjects

listObjects(
    prefix: string,
    delimiter: string,
    continuationToken: string,
    startAfter: string,
    maxKeys: number,
): Promise<ListObjectsResponse>
Parameters
- prefix: string
- delimiter: string
- continuationToken: string
- startAfter: string
- maxKeys: number
Returns Promise<ListObjectsResponse>

listObjectsRaw

listObjectsRaw(
    request: {
        prefix?: string;
        delimiter?: string;
        continuationToken?: string;
        startAfter?: string;
        maxKeys?: number;
    },
): Promise<ListObjectsResponse>
Parameters
- request: {
      prefix?: string;
      delimiter?: string;
      continuationToken?: string;
      startAfter?: string;
      maxKeys?: number;
  }
Returns Promise<ListObjectsResponse>

copyObject

copyObject(
    ifMatch: string,
    ifNoneMatch: string,
    source?: { key?: string; versionId?: string },
    destination?: { key?: string; versionId?: string },
): Promise<CopyObjectResponse>
Parameters
- ifMatch: string
- ifNoneMatch: string
- Optionalsource: { key?: string; versionId?: string }
- Optionaldestination: { key?: string; versionId?: string }
Returns Promise<CopyObjectResponse>

copyObjectRaw

copyObjectRaw(
    request: {
        source?: { key?: string; versionId?: string };
        destination?: { key?: string; versionId?: string };
        ifMatch?: string;
        ifNoneMatch?: string;
    },
): Promise<CopyObjectResponse>
Parameters
- request: {
      source?: { key?: string; versionId?: string };
      destination?: { key?: string; versionId?: string };
      ifMatch?: string;
      ifNoneMatch?: string;
  }
Returns Promise<CopyObjectResponse>

presignObject

presignObject(
    method: number,
    expiresSeconds: bigint,
    ref?: { key?: string; versionId?: string },
    options?: { contentType?: string; contentDisposition?: string },
): Promise<PresignObjectResponse>
Parameters
- method: number
- expiresSeconds: bigint
- Optionalref: { key?: string; versionId?: string }
- Optionaloptions: { contentType?: string; contentDisposition?: string }
Returns Promise<PresignObjectResponse>

presignObjectRaw

presignObjectRaw(
    request: {
        ref?: { key?: string; versionId?: string };
        method?: number;
        expiresSeconds?: bigint;
        contentType?: string;
        contentDisposition?: string;
        headers?: { [key: string]: string };
    },
): Promise<PresignObjectResponse>
Parameters
- request: {
      ref?: { key?: string; versionId?: string };
      method?: number;
      expiresSeconds?: bigint;
      contentType?: string;
      contentDisposition?: string;
      headers?: { [key: string]: string };
  }
Returns Promise<PresignObjectResponse>

Class S3

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns S3

Methods

Staticconnect

Parameters

Returns S3

headObject

Parameters

Returns Promise<HeadObjectResponse>

headObjectRaw

Parameters

Returns Promise<HeadObjectResponse>

readObject

Parameters

Returns Promise<{ meta: S3ObjectMeta; data: ByteStream }>

readObjectRaw

Parameters

Returns AsyncIterable<ReadObjectChunk>

writeObject

Parameters

Returns Promise<WriteObjectResponse>

writeObjectRaw

Parameters

Returns Promise<WriteObjectResponse>

deleteObject

Parameters

Returns Promise<void>

deleteObjectRaw

Parameters

Returns Promise<void>

listObjects

Parameters

Returns Promise<ListObjectsResponse>

listObjectsRaw

Parameters

Returns Promise<ListObjectsResponse>

copyObject

Parameters

Returns Promise<CopyObjectResponse>

copyObjectRaw

Parameters

Returns Promise<CopyObjectResponse>

presignObject

Parameters

Returns Promise<PresignObjectResponse>

presignObjectRaw

Parameters

Returns Promise<PresignObjectResponse>

Settings

On This Page

`Static`connect