Skip to main content

IpcProvider <API>

The IPC Provider could be used in node.js dapps when running a local node. And it provide the most secure connection.

@example
const provider = new IpcProvider(
        `path.ipc`,
        {
            writable: false,
        },
        {
            delay: 500,
            autoReconnect: true,
            maxAttempts: 10,
        },
    );

The second and the third parameters are both optional. And you can for example, the second parameter could be an empty object or undefined.

  • @example
    const provider = new IpcProvider(
         `path.ipc`,
         {},
         {
             delay: 500,
             autoReconnect: true,
             maxAttempts: 10,
         },
     );

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new IpcProvider<API>(socketPath: string, socketOptions?: object, reconnectOptions?: ReconnectOptions): default<API>

  • Type parameters

    Parameters

    • socketPath: string
    • optionalsocketOptions: object
    • optionalreconnectOptions: ReconnectOptions

    Returns default<API>

Accessors

SocketConnection

  • get SocketConnection(): unknown

  • Returns unknown

[symbol]

  • get [symbol](): boolean

  • Returns boolean

Methods

connect

  • connect(): void

  • Returns void

disconnect

  • disconnect(code?: number, data?: string): void

  • Parameters

    • optionalcode: number
    • optionaldata: string

    Returns void

publicgetStatus

on

once

removeAllListeners

  • removeAllListeners(type: string): void

  • Parameters

    • type: string

    Returns void

removeListener

request

reset

  • reset(): void

  • Returns void

send

sendAsync

supportsSubscriptions

  • supportsSubscriptions(): boolean

  • Returns boolean

staticisWeb3Provider

  • isWeb3Provider(provider: unknown): boolean

  • Parameters

    • provider: unknown

    Returns boolean