Interface NatsConnection

Interface representing a NATS Connection

interface NatsConnection {
    close(): Promise<void>;
    jetstream(options?: NatsJetStreamOptions): NatsJetStreamClient;
    jetstreamManager(options?: NatsJetStreamOptions): Promise<NatsJetStreamManager>;
    mintKey(type: KeyType, params: KeyStoreParams): string;
    transact(): ProviderTransaction;
}

Hierarchy (view full)

ProviderClient
- NatsConnection

Index

Methods

close jetstream jetstreamManager mintKey transact

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in types/nats.ts:35

jetstream

jetstream(options?): NatsJetStreamClient
Parameters
- Optionaloptions: NatsJetStreamOptions
Returns NatsJetStreamClient
- Defined in types/nats.ts:31

jetstreamManager

jetstreamManager(options?): Promise<NatsJetStreamManager>
Parameters
- Optionaloptions: NatsJetStreamOptions
Returns Promise<NatsJetStreamManager>
- Defined in types/nats.ts:32

mintKey

mintKey(type, params): string
Mint a provider-specific key
Parameters
- type: KeyType
- params: KeyStoreParams
Returns string
Inherited from ProviderClient.mintKey
- Defined in types/provider.ts:56

transact

transact(): ProviderTransaction
The provider-specific transaction object

Returns ProviderTransaction
Inherited from ProviderClient.transact
- Defined in types/provider.ts:53