Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Container<T>

The Container provides an interface for accessing operations dealing with the container schema. It can conventially be retrieved from the Model.container() method, but you can also instantiate it manually.

Type parameters

  • T

Hierarchy

  • Container

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Container<T>(schema: BasicSchema<T>, instance: Container): Container<T>
  • Type parameters

    • T

    Parameters

    • schema: BasicSchema<T>
    • instance: Container

    Returns Container<T>

Properties

Readonly instance

instance: Container

Methods

create

  • create(options?: RequestOptions): Promise<ContainerResponse>
  • Creates the container for the model.

    Parameters

    • Optional options: RequestOptions

    Returns Promise<ContainerResponse>

createIfNotExists

  • createIfNotExists(options?: RequestOptions): Promise<ContainerResponse>
  • Creates the container for the model.

    Parameters

    • Optional options: RequestOptions

    Returns Promise<ContainerResponse>

delete

  • delete(options?: RequestOptions): Promise<ContainerResponse>
  • Delete the container.

    Parameters

    • Optional options: RequestOptions

    Returns Promise<ContainerResponse>

replace

  • replace(options?: RequestOptions): Promise<ContainerResponse>
  • Replace the container's definition.

    Parameters

    • Optional options: RequestOptions

    Returns Promise<ContainerResponse>

Generated using TypeDoc