diff --git a/classes/ObjectStorageError.html b/classes/ObjectStorageError.html index af124b3e..79393df2 100644 --- a/classes/ObjectStorageError.html +++ b/classes/ObjectStorageError.html @@ -1,4 +1,4 @@ -ObjectStorageError | @relaycorp/object-storage

Class ObjectStorageError

Hierarchy

  • VError
    • ObjectStorageError

Constructors

constructor +ObjectStorageError | @relaycorp/object-storage

Class ObjectStorageError

Hierarchy

  • VError
    • ObjectStorageError

Constructors

constructor

Properties

cause message name @@ -14,7 +14,7 @@ fullStack hasCauseWithName info -

Constructors

constructor

  • new ObjectStorageError(options, message, ...params): ObjectStorageError

  • Parameters

    • options: Error | Options
    • message: string
    • Rest ...params: any[]

    Returns ObjectStorageError

  • new ObjectStorageError(message?, ...params): ObjectStorageError

  • Parameters

    • Optional message: string
    • Rest ...params: any[]

    Returns ObjectStorageError

Properties

cause

cause: (() => undefined | Error)

Type declaration

    • (): undefined | Error

    • Returns undefined | Error

message

message: string

Readonly name

name: "ObjectStorageError" = 'ObjectStorageError'

Optional stack

stack?: string

Static VError

VError: typeof VError

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

  • new ObjectStorageError(options, message, ...params): ObjectStorageError

  • Parameters

    • options: Error | Options
    • message: string
    • Rest ...params: any[]

    Returns ObjectStorageError

  • new ObjectStorageError(message?, ...params): ObjectStorageError

  • Parameters

    • Optional message: string
    • Rest ...params: any[]

    Returns ObjectStorageError

Properties

cause

cause: (() => undefined | Error)

Type declaration

    • (): undefined | Error

    • Returns undefined | Error

message

message: string

Readonly name

name: "ObjectStorageError" = 'ObjectStorageError'

Optional stack

stack?: string

Static VError

VError: typeof VError

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static cause

  • cause(err): null | Error

  • Parameters

    • err: Error

    Returns null | Error

Static errorForEach

  • errorForEach(err, func): void

  • Parameters

    • err: Error
    • func: ((err) => void)
        • (err): void

        • Parameters

          • err: Error

          Returns void

    Returns void

Static errorFromList

  • errorFromList<T>(errors): null | T | MultiError

  • Type Parameters

    • T extends Error

    Parameters

    • errors: T[]

    Returns null | T | MultiError

Static findCauseByName

  • findCauseByName(err, name): null | Error

  • Parameters

    • err: Error
    • name: string

    Returns null | Error

Static fullStack

  • fullStack(err): string

  • Parameters

    • err: Error

    Returns string

Static hasCauseWithName

  • hasCauseWithName(err, name): boolean

  • Parameters

    • err: Error
    • name: string

    Returns boolean

Static info

  • info(err): Info

  • Parameters

    • err: Error

    Returns Info

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/initObjectStoreClient.html b/functions/initObjectStoreClient.html index 4ebfc784..648b3bec 100644 --- a/functions/initObjectStoreClient.html +++ b/functions/initObjectStoreClient.html @@ -1,2 +1,2 @@ initObjectStoreClient | @relaycorp/object-storage

Function initObjectStoreClient

  • initObjectStoreClient(type, endpoint?, accessKeyId?, secretAccessKey?, tlsEnabled?): ObjectStoreClient

  • Return object store client for the specified type.

    -

    Parameters

    • type: AdapterType
    • Optional endpoint: string
    • Optional accessKeyId: string
    • Optional secretAccessKey: string
    • tlsEnabled: boolean = true

    Returns ObjectStoreClient

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns ObjectStoreClient

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/ObjectStoreClient.html b/interfaces/ObjectStoreClient.html index 1470f504..a868db1f 100644 --- a/interfaces/ObjectStoreClient.html +++ b/interfaces/ObjectStoreClient.html @@ -1,5 +1,5 @@ ObjectStoreClient | @relaycorp/object-storage

Interface ObjectStoreClient

Interface for all object store clients.

-
interface ObjectStoreClient {
    deleteObject: ((key, bucket) => Promise<void>);
    getObject: ((key, bucket) => Promise<null | StoreObject>);
    listObjectKeys: ((prefix, bucket) => AsyncIterable<string>);
    putObject: ((object, key, bucket) => Promise<void>);
}

Properties

deleteObject +
interface ObjectStoreClient {
    deleteObject: ((key, bucket) => Promise<void>);
    getObject: ((key, bucket) => Promise<null | StoreObject>);
    listObjectKeys: ((prefix, bucket) => AsyncIterable<string>);
    putObject: ((object, key, bucket) => Promise<void>);
}

Properties

deleteObject getObject listObjectKeys putObject @@ -7,7 +7,7 @@

This method resolves even if the key doesn't exist, in order to provide a normalised API, since Amazon S3 always returns a 204 regardless of whether the object exists (GCS returns a 404 and its SDK throws an error).

-

Parameters

  • key: string
  • bucket: string

Returns Promise<void>

Readonly getObject

getObject: ((key, bucket) => Promise<null | StoreObject>)

Type declaration

    • (key, bucket): Promise<null | StoreObject>

    • Retrieve the object by key or return null if the key doesn't exist.

      -

      Parameters

      • key: string
      • bucket: string

      Returns Promise<null | StoreObject>

Readonly listObjectKeys

listObjectKeys: ((prefix, bucket) => AsyncIterable<string>)

Type declaration

    • (prefix, bucket): AsyncIterable<string>

    • Retrieve the keys for all the objects in the specified bucket with the specified key prefix.

      +

      Parameters

      • key: string
      • bucket: string

      Returns Promise<void>

Readonly getObject

getObject: ((key, bucket) => Promise<null | StoreObject>)

Type declaration

    • (key, bucket): Promise<null | StoreObject>

    • Retrieve the object by key or return null if the key doesn't exist.

      +

      Parameters

      • key: string
      • bucket: string

      Returns Promise<null | StoreObject>

Readonly listObjectKeys

listObjectKeys: ((prefix, bucket) => AsyncIterable<string>)

Type declaration

    • (prefix, bucket): AsyncIterable<string>

    • Retrieve the keys for all the objects in the specified bucket with the specified key prefix.

      This will handle pagination if the backend supports it (S3 does, Minio doesn't).

      -

      Parameters

      • prefix: string
      • bucket: string

      Returns AsyncIterable<string>

Readonly putObject

putObject: ((object, key, bucket) => Promise<void>)

Type declaration

    • (object, key, bucket): Promise<void>

    • Parameters

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns AsyncIterable<string>

Readonly putObject

putObject: ((object, key, bucket) => Promise<void>)

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/StoreObject.html b/interfaces/StoreObject.html index 4319d83f..e609ed52 100644 --- a/interfaces/StoreObject.html +++ b/interfaces/StoreObject.html @@ -1,4 +1,4 @@ StoreObject | @relaycorp/object-storage

Interface StoreObject

Store object.

-
interface StoreObject {
    body: Buffer;
    metadata: {
        [key: string]: string;
    };
}

Properties

body +
interface StoreObject {
    body: Buffer;
    metadata: {
        [key: string]: string;
    };
}

Properties

body metadata -

Properties

Readonly body

body: Buffer

Readonly metadata

metadata: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly body

body: Buffer

Readonly metadata

metadata: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/types/AdapterType.html b/types/AdapterType.html index 93fcf87c..c0a6fe70 100644 --- a/types/AdapterType.html +++ b/types/AdapterType.html @@ -1 +1 @@ -AdapterType | @relaycorp/object-storage

Type alias AdapterType

AdapterType: "gcs" | "minio" | "s3"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AdapterType | @relaycorp/object-storage

Type alias AdapterType

AdapterType: "gcs" | "minio" | "s3"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file