Class CommandLineInterface

Intended to manage server side running of Gink. Basically it takes some settings in the form of arguments plus a list of peers to connect to then starts up the Gink Instance, or Gink Server if port listening is specified.

Constructors

constructor

Properties

authToken? instance? logger replServer? retryOnDisconnect store? targets

Methods

run

Constructors

constructor

  • new CommandLineInterface(
        args: {
            auth_token?: string;
            connect_to?: string[];
            data_file?: string;
            exclusive?: boolean;
            identity?: string;
            listen_on?: string;
            reconnect?: boolean;
            ssl_cert?: string;
            ssl_key?: string;
            static_path?: string;
            verbose?: boolean;
        },
    ): CommandLineInterface

  • Parameters

    • args: {
          auth_token?: string;
          connect_to?: string[];
          data_file?: string;
          exclusive?: boolean;
          identity?: string;
          listen_on?: string;
          reconnect?: boolean;
          ssl_cert?: string;
          ssl_key?: string;
          static_path?: string;
          verbose?: boolean;
      }

    Returns CommandLineInterface

Properties

OptionalauthToken

authToken?: string

Optionalinstance

instance?: Database

logger

logger: (_: string) => void

OptionalreplServer

replServer?: REPLServer

retryOnDisconnect

retryOnDisconnect: boolean

Optionalstore

store?: Store

targets

targets: string[]

Methods

run

Settings

Member Visibility

On This Page

Constructors
Properties
Methods