Class ScProvider

Implements

ProviderInterface

Index

Constructors

Accessors

hasSubscriptions isClonable isConnected

Methods

clone connect disconnect on send subscribe unsubscribe

Constructors

constructor

new ScProvider(
    Sc: BizinikiwiConnect,
    spec: string,
    sharedSandbox?: ScProvider,
): ScProvider
Parameters
- Sc: BizinikiwiConnect
- spec: string
- OptionalsharedSandbox: ScProvider
Returns ScProvider
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:67

Accessors

hasSubscriptions

get hasSubscriptions(): boolean
true if the provider supports subscriptions (not available for HTTP)

Returns boolean
Implementation of ProviderInterface.hasSubscriptions
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:78

isClonable

get isClonable(): boolean
true if the clone() functionality is available on the provider

Returns boolean
Implementation of ProviderInterface.isClonable
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:83

isConnected

get isConnected(): boolean
true if the provider is currently connected (ws/sc has connection logic)

Returns boolean
Implementation of ProviderInterface.isConnected
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:87

Methods

clone

clone(): ProviderInterface
Returns ProviderInterface
Implementation of ProviderInterface.clone
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:91

connect

connect(config?: Config, checkerFactory?: () => HealthChecker): Promise<void>
Parameters
- Optionalconfig: Config
- checkerFactory: () => HealthChecker = healthChecker
Returns Promise<void>
Implementation of ProviderInterface.connect
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:97

disconnect

disconnect(): Promise<void>
Returns Promise<void>
Implementation of ProviderInterface.disconnect
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:313

on

on(type: ProviderInterfaceEmitted, sub: ProviderInterfaceEmitCb): () => void
Parameters
- type: ProviderInterfaceEmitted
- sub: ProviderInterfaceEmitCb
Returns () => void
Implementation of ProviderInterface.on
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:330

send

send<T = any>(method: string, params: unknown[]): Promise<T>
Type Parameters
- T = any
Parameters
- method: string
- params: unknown[]
Returns Promise<T>
Implementation of ProviderInterface.send
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:345

subscribe(
    type: string,
    method: string,
    params: any[],
    callback: ProviderInterfaceCallback,
): Promise<string | number>
Parameters
- type: string
- method: string
- params: any[]
- callback: ProviderInterfaceCallback
Returns Promise<string | number>
Implementation of ProviderInterface.subscribe
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:380

unsubscribe

unsubscribe(type: string, method: string, id: string | number): Promise<boolean>
Parameters
- type: string
- method: string
- id: string | number
Returns Promise<boolean>
Implementation of ProviderInterface.unsubscribe
- Defined in packages/rpc-provider/src/bizinikiwi-connect/index.ts:409