Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "index"

Index

Type aliases

DataTransformer

DataTransformer: function

A data transformer.

param

The context.

returns

The result.

DataTransformerResult

DataTransformerResult: Buffer | PromiseLike<Buffer>

A result for of a data transformer.

ListenCallback

ListenCallback: function

A listener callback.

param

The error (if occurred).

param

The socket if no error ocurred.

Type declaration

PasswordGenerator

PasswordGenerator: function

A password generator.

returns

The result.

Type declaration

PasswordGeneratorResult

PasswordGeneratorResult: Buffer | PromiseLike<Buffer> | string | PromiseLike<string>

The result of a password generator.

Variables

Compress

Compress: boolean

Default value that indicates if compression should be used or not.

DEFAULT_DEFAULT_READ_BUFFER_SIZE

DEFAULT_DEFAULT_READ_BUFFER_SIZE: number = 8192

DEFAULT_ENCODING

DEFAULT_ENCODING: string = "utf8"

The default (string) encoding.

DEFAULT_MAX_PACKAGE_SIZE

DEFAULT_MAX_PACKAGE_SIZE: number = 16777211

DEFAULT_RSA_KEY_SIZE

DEFAULT_RSA_KEY_SIZE: number = 512

DefaultCWD

DefaultCWD: string = process.cwd()

Default working directory.

DefaultDataTransformer

DefaultDataTransformer: DataTransformer

Default data transformer.

DefaultEncoding

DefaultEncoding: string = "utf8"

The default text encoding.

DefaultHandshakeTransformer

DefaultHandshakeTransformer: DataTransformer

Default handshake transformer.

DefaultMaxPackageSize

DefaultMaxPackageSize: number = 16777211

The default size for a maximum data package.

DefaultPasswordGenerator

DefaultPasswordGenerator: PasswordGenerator

The default password generator.

DefaultRSAKeySize

DefaultRSAKeySize: number = 512

The default RSA key size.

DefaultReadBufferSize

DefaultReadBufferSize: number = 8192

Default buffer size for reading streams.

RSA

RSA: any = require('node-rsa')

Functions

asDataTransformerPromise

connect

  • connect(port: number, host?: string): Promise<SimpleSocket>
  • Connects to a remote (server).

    Parameters

    • port: number

      The TCP port of the remote machine.

    • Optional host: string

      The host (address).

    Returns Promise<SimpleSocket>

    The promise.

create

  • Creates a new instance.

    Parameters

    • Optional socket: Socket
    • Default value type: SocketType = SocketType.Client

    Returns SimpleSocket

    The new instance.

createClient

  • Creates a new CLIENT instance.

    Parameters

    • Optional socket: Socket

    Returns SimpleSocket

    The new instance.

createServer

  • Creates a new SERVER instance.

    Parameters

    • Optional socket: Socket

    Returns SimpleSocket

    The new instance.

listen

  • Starts listening on a port.

    Parameters

    • port: number

      The TCP port to listen on.

    • cb: ListenCallback

      The listener callback.

    Returns Promise<Server>

    The promise.

toDataTransformerSave

Generated using TypeDoc