KvService | @rivet-gg/kv

Hierarchy

KvServiceClient
KvServiceClient
- KvService

Implements

Client<ServiceInputTypes, ServiceOutputTypes, KvServiceClientResolvedConfig>
Client<ServiceInputTypes, ServiceOutputTypes, KvServiceClientResolvedConfig>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new KvService(configuration: KvServiceClientConfig): KvService

Inherited from KvServiceClient.constructor

Overrides Client.__constructor
- Defined in clients/client/src/KvServiceClient.ts:235
Parameters
- configuration: KvServiceClientConfig
Returns KvService

Properties

Readonly config

config: KvServiceClientResolvedConfig

The resolved configuration of KvServiceClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

delete

delete(args: DeleteCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCommandOutput>
delete(args: DeleteCommandInput, cb: (err: any, data?: DeleteCommandOutput) => void): void
delete(args: DeleteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCommandOutput) => void): void
delete(args: DeleteCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCommandOutput>
delete(args: DeleteCommandInput, cb: (err: any, data?: DeleteCommandOutput) => void): void
delete(args: DeleteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCommandOutput) => void): void

- Defined in clients/client/src/KvService.ts:39
Deletes a key-value entry by key.

Parameters
- args: DeleteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteCommandOutput>
- Defined in clients/client/src/KvService.ts:43
Deletes a key-value entry by key.

Parameters
- args: DeleteCommandInput
- cb: (err: any, data?: DeleteCommandOutput) => void
  - - (err: any, data?: DeleteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/KvService.ts:47
Deletes a key-value entry by key.

Parameters
- args: DeleteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteCommandOutput) => void
  - - (err: any, data?: DeleteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:13
Deletes a key-value entry by key.

Parameters
- args: DeleteCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteCommandOutput>
- Defined in dist-types/KvService.d.ts:14
Deletes a key-value entry by key.

Parameters
- args: DeleteCommandInput
- cb: (err: any, data?: DeleteCommandOutput) => void
  - - (err: any, data?: DeleteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:15
Deletes a key-value entry by key.

Parameters
- args: DeleteCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteCommandOutput) => void
  - - (err: any, data?: DeleteCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteCommandOutput
      Returns void
Returns void

deleteBatch

deleteBatch(args: DeleteBatchCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBatchCommandOutput>
deleteBatch(args: DeleteBatchCommandInput, cb: (err: any, data?: DeleteBatchCommandOutput) => void): void
deleteBatch(args: DeleteBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBatchCommandOutput) => void): void
deleteBatch(args: DeleteBatchCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBatchCommandOutput>
deleteBatch(args: DeleteBatchCommandInput, cb: (err: any, data?: DeleteBatchCommandOutput) => void): void
deleteBatch(args: DeleteBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBatchCommandOutput) => void): void

- Defined in clients/client/src/KvService.ts:72
Deletes multiple key-value entries by key(s).

Parameters
- args: DeleteBatchCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteBatchCommandOutput>
- Defined in clients/client/src/KvService.ts:76
Deletes multiple key-value entries by key(s).

Parameters
- args: DeleteBatchCommandInput
- cb: (err: any, data?: DeleteBatchCommandOutput) => void
  - - (err: any, data?: DeleteBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteBatchCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/KvService.ts:80
Deletes multiple key-value entries by key(s).

Parameters
- args: DeleteBatchCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteBatchCommandOutput) => void
  - - (err: any, data?: DeleteBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteBatchCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:19
Deletes multiple key-value entries by key(s).

Parameters
- args: DeleteBatchCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteBatchCommandOutput>
- Defined in dist-types/KvService.d.ts:20
Deletes multiple key-value entries by key(s).

Parameters
- args: DeleteBatchCommandInput
- cb: (err: any, data?: DeleteBatchCommandOutput) => void
  - - (err: any, data?: DeleteBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteBatchCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:21
Deletes multiple key-value entries by key(s).

Parameters
- args: DeleteBatchCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteBatchCommandOutput) => void
  - - (err: any, data?: DeleteBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteBatchCommandOutput
      Returns void
Returns void

destroy

destroy(): void

Inherited from KvServiceClient.destroy

Overrides Client.destroy
- Defined in clients/client/src/KvServiceClient.ts:298
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void

get

get(args: GetCommandInput, options?: __HttpHandlerOptions): Promise<GetCommandOutput>
get(args: GetCommandInput, cb: (err: any, data?: GetCommandOutput) => void): void
get(args: GetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommandOutput) => void): void
get(args: GetCommandInput, options?: __HttpHandlerOptions): Promise<GetCommandOutput>
get(args: GetCommandInput, cb: (err: any, data?: GetCommandOutput) => void): void
get(args: GetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommandOutput) => void): void

- Defined in clients/client/src/KvService.ts:105
Returns a specific key-value entry by key.

Parameters
- args: GetCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetCommandOutput>
- Defined in clients/client/src/KvService.ts:109
Returns a specific key-value entry by key.

Parameters
- args: GetCommandInput
- cb: (err: any, data?: GetCommandOutput) => void
  - - (err: any, data?: GetCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/KvService.ts:113
Returns a specific key-value entry by key.

Parameters
- args: GetCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetCommandOutput) => void
  - - (err: any, data?: GetCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:25
Returns a specific key-value entry by key.

Parameters
- args: GetCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetCommandOutput>
- Defined in dist-types/KvService.d.ts:26
Returns a specific key-value entry by key.

Parameters
- args: GetCommandInput
- cb: (err: any, data?: GetCommandOutput) => void
  - - (err: any, data?: GetCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:27
Returns a specific key-value entry by key.

Parameters
- args: GetCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetCommandOutput) => void
  - - (err: any, data?: GetCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetCommandOutput
      Returns void
Returns void

getBatch

getBatch(args: GetBatchCommandInput, options?: __HttpHandlerOptions): Promise<GetBatchCommandOutput>
getBatch(args: GetBatchCommandInput, cb: (err: any, data?: GetBatchCommandOutput) => void): void
getBatch(args: GetBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBatchCommandOutput) => void): void
getBatch(args: GetBatchCommandInput, options?: __HttpHandlerOptions): Promise<GetBatchCommandOutput>
getBatch(args: GetBatchCommandInput, cb: (err: any, data?: GetBatchCommandOutput) => void): void
getBatch(args: GetBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBatchCommandOutput) => void): void

- Defined in clients/client/src/KvService.ts:138
Gets multiple key-value entries by key(s).

Parameters
- args: GetBatchCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetBatchCommandOutput>
- Defined in clients/client/src/KvService.ts:142
Gets multiple key-value entries by key(s).

Parameters
- args: GetBatchCommandInput
- cb: (err: any, data?: GetBatchCommandOutput) => void
  - - (err: any, data?: GetBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetBatchCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/KvService.ts:146
Gets multiple key-value entries by key(s).

Parameters
- args: GetBatchCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetBatchCommandOutput) => void
  - - (err: any, data?: GetBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetBatchCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:31
Gets multiple key-value entries by key(s).

Parameters
- args: GetBatchCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<GetBatchCommandOutput>
- Defined in dist-types/KvService.d.ts:32
Gets multiple key-value entries by key(s).

Parameters
- args: GetBatchCommandInput
- cb: (err: any, data?: GetBatchCommandOutput) => void
  - - (err: any, data?: GetBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetBatchCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:33
Gets multiple key-value entries by key(s).

Parameters
- args: GetBatchCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: GetBatchCommandOutput) => void
  - - (err: any, data?: GetBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: GetBatchCommandOutput
      Returns void
Returns void

put

put(args: PutCommandInput, options?: __HttpHandlerOptions): Promise<PutCommandOutput>
put(args: PutCommandInput, cb: (err: any, data?: PutCommandOutput) => void): void
put(args: PutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCommandOutput) => void): void
put(args: PutCommandInput, options?: __HttpHandlerOptions): Promise<PutCommandOutput>
put(args: PutCommandInput, cb: (err: any, data?: PutCommandOutput) => void): void
put(args: PutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCommandOutput) => void): void

- Defined in clients/client/src/KvService.ts:171
Puts (sets or overwrites) a key-value entry by key.

Parameters
- args: PutCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<PutCommandOutput>
- Defined in clients/client/src/KvService.ts:175
Puts (sets or overwrites) a key-value entry by key.

Parameters
- args: PutCommandInput
- cb: (err: any, data?: PutCommandOutput) => void
  - - (err: any, data?: PutCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PutCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/KvService.ts:179
Puts (sets or overwrites) a key-value entry by key.

Parameters
- args: PutCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: PutCommandOutput) => void
  - - (err: any, data?: PutCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PutCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:37
Puts (sets or overwrites) a key-value entry by key.

Parameters
- args: PutCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<PutCommandOutput>
- Defined in dist-types/KvService.d.ts:38
Puts (sets or overwrites) a key-value entry by key.

Parameters
- args: PutCommandInput
- cb: (err: any, data?: PutCommandOutput) => void
  - - (err: any, data?: PutCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PutCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:39
Puts (sets or overwrites) a key-value entry by key.

Parameters
- args: PutCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: PutCommandOutput) => void
  - - (err: any, data?: PutCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PutCommandOutput
      Returns void
Returns void

putBatch

putBatch(args: PutBatchCommandInput, options?: __HttpHandlerOptions): Promise<PutBatchCommandOutput>
putBatch(args: PutBatchCommandInput, cb: (err: any, data?: PutBatchCommandOutput) => void): void
putBatch(args: PutBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBatchCommandOutput) => void): void
putBatch(args: PutBatchCommandInput, options?: __HttpHandlerOptions): Promise<PutBatchCommandOutput>
putBatch(args: PutBatchCommandInput, cb: (err: any, data?: PutBatchCommandOutput) => void): void
putBatch(args: PutBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutBatchCommandOutput) => void): void

- Defined in clients/client/src/KvService.ts:204
Puts (sets or overwrites) multiple key-value entries by key(s).

Parameters
- args: PutBatchCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<PutBatchCommandOutput>
- Defined in clients/client/src/KvService.ts:208
Puts (sets or overwrites) multiple key-value entries by key(s).

Parameters
- args: PutBatchCommandInput
- cb: (err: any, data?: PutBatchCommandOutput) => void
  - - (err: any, data?: PutBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PutBatchCommandOutput
      Returns void
Returns void
- Defined in clients/client/src/KvService.ts:212
Puts (sets or overwrites) multiple key-value entries by key(s).

Parameters
- args: PutBatchCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: PutBatchCommandOutput) => void
  - - (err: any, data?: PutBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PutBatchCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:43
Puts (sets or overwrites) multiple key-value entries by key(s).

Parameters
- args: PutBatchCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<PutBatchCommandOutput>
- Defined in dist-types/KvService.d.ts:44
Puts (sets or overwrites) multiple key-value entries by key(s).

Parameters
- args: PutBatchCommandInput
- cb: (err: any, data?: PutBatchCommandOutput) => void
  - - (err: any, data?: PutBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PutBatchCommandOutput
      Returns void
Returns void
- Defined in dist-types/KvService.d.ts:45
Puts (sets or overwrites) multiple key-value entries by key(s).

Parameters
- args: PutBatchCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: PutBatchCommandOutput) => void
  - - (err: any, data?: PutBatchCommandOutput): void
    - Parameters
      - err: any
      - Optional data: PutBatchCommandOutput
      Returns void
Returns void

send

send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options?: HandlerOptions): Promise<OutputType>
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, cb: (err: any, data?: OutputType) => void): void
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options: __HttpHandlerOptions, cb: (err: any, data?: OutputType) => void): void

Inherited from KvServiceClient.send

Overrides KvServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:16
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- Optional options: HandlerOptions
Returns Promise<OutputType>
Inherited from KvServiceClient.send

Overrides KvServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:17
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void
Inherited from KvServiceClient.send

Overrides KvServiceClient.send
- Defined in node_modules/@aws-sdk/smithy-client/dist-types/client.d.ts:18
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- options: __HttpHandlerOptions
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: KvServiceClientConfig

Returns KvService

Properties

Readonly config

middlewareStack

Methods

delete

Parameters

args: DeleteCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<DeleteCommandOutput>

Parameters

args: DeleteCommandInput

cb: (err: any, data?: DeleteCommandOutput) => void

Parameters

err: any

Optional data: DeleteCommandOutput

Returns void

Returns void

Parameters

args: DeleteCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: DeleteCommandOutput) => void

Parameters

err: any

Optional data: DeleteCommandOutput

Returns void

Returns void

Parameters

args: DeleteCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<DeleteCommandOutput>

Parameters

args: DeleteCommandInput

cb: (err: any, data?: DeleteCommandOutput) => void

Parameters

err: any

Optional data: DeleteCommandOutput

Returns void

Returns void

Parameters

args: DeleteCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: DeleteCommandOutput) => void

Parameters

err: any

Optional data: DeleteCommandOutput

Returns void

Returns void

deleteBatch

Parameters

args: DeleteBatchCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<DeleteBatchCommandOutput>

Parameters

args: DeleteBatchCommandInput

cb: (err: any, data?: DeleteBatchCommandOutput) => void

Parameters

err: any

Optional data: DeleteBatchCommandOutput

Returns void

Returns void

Parameters

args: DeleteBatchCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: DeleteBatchCommandOutput) => void

Parameters

err: any

Optional data: DeleteBatchCommandOutput

Returns void

Returns void