Class Bitnode

The Bitnode class represents a Bitnode connection.

It provides methods to interact with a Bitnode instance.

Constructors

constructor

new Bitnode(apiUrl, domain?, gateway?): Bitnode
Creates a new Bitnode instance.
Parameters
- apiUrl: string
  The URL of the Bitnode websocket server.
- Optional domain: Domain
  The domain to use for the Bitnode instance.
- Optional gateway: Gateway
  The gateway to use for the Bitnode instance. If not provided, a new Gateway will be created.
Returns Bitnode
- Defined in bitnode/bitnode.ts:72

Properties

`Private` _closeWs

_closeWs: Subject<void> = ...

`Private` `Optional` _domain

_domain?: Domain

`Private` _gateway

_gateway: Gateway = ...

`Private` _holograms

_holograms: WaitMap<string, InternalHologram> = ...

`Private` _queries

_queries: Map<string, QueryResultInternal<any>> = ...

`Private` _requests

_requests: Map<string, [responseResolve, responseError]> = ...

`Private` `Optional` _ws

_ws?: WebSocket

`Private` apiUrl

apiUrl: string

The URL of the Bitnode websocket server.

`Private` cbs

cbs: HologramCallbacks = ...

`Static` `Private` _handlers

_handlers: Map<string, ((payload) => Promise<SerializedType>)> = ...

Type declaration

- (payload): Promise<SerializedType>
- Parameters
  - payload: SerializedType
  Returns Promise<SerializedType>

`Static` `Private` _instance

_instance: undefined | Bitnode

`Static` models

models: Map<string, hologramCtor<Hologram>> = ...

Accessors

domain

get domain(): undefined | Domain
Returns undefined | Domain
- Defined in bitnode/bitnode.ts:170

gateway

get gateway(): Gateway
Returns Gateway
- Defined in bitnode/bitnode.ts:166

`Static` `Private` instance

set instance(bitnode): void
Parameters
- bitnode: undefined | Bitnode
Returns void
- Defined in bitnode/bitnode.ts:45

Methods

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in bitnode/bitnode.ts:107

`Private` createClassHologram

createClassHologram(clazz, values?): Promise<InternalHologram>
Parameters
- clazz: string
- Optional values: Serialized<ValueType>
Returns Promise<InternalHologram>
- Defined in bitnode/bitnode.ts:344

`Private` createModelHologram

createModelHologram(model, values?): Promise<InternalHologram>
Parameters
- model: string
- Optional values: Serialized<ValueType>
Returns Promise<InternalHologram>
- Defined in bitnode/bitnode.ts:324

deleteHologram

deleteHologram(hologramId): Promise<void>
Parameters
- hologramId: string
Returns Promise<void>
- Defined in bitnode/bitnode.ts:258

disconnect

disconnect(): Promise<void>
Returns Promise<void>
- Defined in bitnode/bitnode.ts:153

`Private` gatewayEmitHologramValue

gatewayEmitHologramValue(payload): Promise<SerializedType>
Called when a hologram value is emitted for a hologram that the gateway has subscribed to.
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:540

`Private` gatewayGetBlueprint

gatewayGetBlueprint(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:495

`Private` gatewayGetBlueprints

gatewayGetBlueprints(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:490

`Private` gatewayGetName

gatewayGetName(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:475

`Private` gatewayGetPlugin

gatewayGetPlugin(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:485

`Private` gatewayGetVersion

gatewayGetVersion(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:480

`Private` gatewayInvoke

gatewayInvoke(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:511

`Private` gatewayInvokeDirect

gatewayInvokeDirect(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:523

`Private` gatewayLoad

gatewayLoad(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:448

`Private` gatewayModel

gatewayModel(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:470

`Private` gatewayQueryAdd

gatewayQueryAdd(payload): Promise<SerializedType>
Called when a hologram is added to a query that the gateway has subscribed to.
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:548

`Private` gatewayQueryInitialDone

gatewayQueryInitialDone(payload): Promise<SerializedType>
Called when a query has finished its initial query.
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:566

`Private` gatewayQueryRemove

gatewayQueryRemove(payload): Promise<SerializedType>
Called when a hologram is removed from a query that the gateway has subscribed to.
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:557

`Private` gatewaySetHologramValue

gatewaySetHologramValue(payload): Promise<SerializedType>
Called when a hologram value is set for a hologram that the gateway has subscribed to.
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:531

`Private` gatewayStart

gatewayStart(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:442

`Private` gatewayStop

gatewayStop(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:461

`Private` gatewayUpdate

gatewayUpdate(payload): Promise<SerializedType>
Parameters
- payload: SerializedType
Returns Promise<SerializedType>
- Defined in bitnode/bitnode.ts:501

getDomain

getDomain(): Promise<Domain>
Returns Promise<Domain>
- Defined in bitnode/bitnode.ts:186

getFixture

getFixture<T>(hgCtor, name): Promise<T>
Type Parameters
- T extends Hologram
Parameters
- hgCtor: hologramCtor<T>
- name: string
Returns Promise<T>
- Defined in bitnode/bitnode.ts:303

getFixtures

getFixtures(): Promise<InternalFixture[]>
Returns Promise<InternalFixture[]>
- Defined in bitnode/bitnode.ts:310

getGateways

getGateways(): Promise<GatewayInfo[]>
Returns Promise<GatewayInfo[]>
- Defined in bitnode/bitnode.ts:200

getHologram

getHologram<T>(hgCtor, holoId): Promise<T>
Type Parameters
- T extends Hologram
Parameters
- hgCtor: hologramCtor<T>
- holoId: string
Returns Promise<T>
- Defined in bitnode/bitnode.ts:230

getHolograms

getHolograms(meta): Promise<InternalBaseHologram[]>
Parameters
- meta: {
      class: string;
      gateway: string;
      model: string;
  }
  - class: string
  - gateway: string
  - model: string
Returns Promise<InternalBaseHologram[]>
- Defined in bitnode/bitnode.ts:237

getId

getId(): Promise<string>
Returns Promise<string>
- Defined in bitnode/bitnode.ts:174

getName

getName(): Promise<string>
Returns Promise<string>
- Defined in bitnode/bitnode.ts:178

getPlugins

getPlugins(): Promise<PluginInfo[]>
Returns Promise<PluginInfo[]>
- Defined in bitnode/bitnode.ts:193

`Private` handle

handle(msg): Promise<void>
Parameters
- msg: Msg
Returns Promise<void>
- Defined in bitnode/bitnode.ts:626

query

query<T>(hgCtor, keepAlive?, filters?, sortings?, offset?, limit?): Promise<QueryResult<T>>
Type Parameters
- T extends Hologram
Parameters
- hgCtor: hologramCtor<T>
- keepAlive: boolean = true
- Optional filters: QueryFilter[]
- Optional sortings: QuerySorting[]
- Optional offset: number
- Optional limit: number
Returns Promise<QueryResult<T>>
- Defined in bitnode/bitnode.ts:268

`Private` receiveHologramValue

receiveHologramValue(payload): Promise<void>
Parameters
- payload: Serialized<any>
Returns Promise<void>
- Defined in bitnode/bitnode.ts:394

`Private` receiveQueryAdd

receiveQueryAdd(payload): Promise<void>
Parameters
- payload: Serialized<any>
Returns Promise<void>
- Defined in bitnode/bitnode.ts:407

`Private` receiveQueryInitialDone

receiveQueryInitialDone(payload): Promise<void>
Parameters
- payload: Serialized<any>
Returns Promise<void>
- Defined in bitnode/bitnode.ts:429

`Private` receiveQueryRemove

receiveQueryRemove(payload): Promise<void>
Parameters
- payload: Serialized<any>
Returns Promise<void>
- Defined in bitnode/bitnode.ts:419

`Private` send

send(msg): void
Parameters
- msg: Msg
Returns void
- Defined in bitnode/bitnode.ts:662

`Private` sendAsync

sendAsync<U>(cmd, payload): void
Type Parameters
- U extends ValueType
Parameters
- cmd: string
- payload: Serialized<U>
Returns void
- Defined in bitnode/bitnode.ts:617

`Private` sendHologramValue

sendHologramValue(hgId, name, value): Promise<void>
Parameters
- hgId: string
- name: string
- value: Serialized<ValueType>
Returns Promise<void>
- Defined in bitnode/bitnode.ts:384

`Private` sendSync

sendSync<T, U>(cmd, payload?): Promise<T>
Type Parameters
- T extends ValueType
- U extends ValueType = ValueType
Parameters
- cmd: string
- Optional payload: Serialized<U>
Returns Promise<T>
- Defined in bitnode/bitnode.ts:581

`Private` sendSyncSerialized

sendSyncSerialized<T, U>(cmd, payload?): Promise<Serialized<T>>
Type Parameters
- T extends ValueType
- U extends ValueType = ValueType
Parameters
- cmd: string
- Optional payload: Serialized<U>
Returns Promise<Serialized<T>>
- Defined in bitnode/bitnode.ts:599

setName

setName(name): void
Parameters
- name: string
Returns void
- Defined in bitnode/bitnode.ts:182

spark

spark<T>(hgCtor, values, gateway?, clazz?): Promise<T>
Type Parameters
- T extends Hologram
Parameters
- hgCtor: hologramCtor<T>
- values: SerializedType | Serialized<ValueMapType>
- Optional gateway: string
- Optional clazz: string
Returns Promise<T>
- Defined in bitnode/bitnode.ts:207

`Private` unpackHologram

unpackHologram(packedHg): Promise<InternalHologram>
Parameters
- packedHg: Serialized<IPackedHologram>
Returns Promise<InternalHologram>
- Defined in bitnode/bitnode.ts:359

`Static` `Private` handler

handler(cmd): ((target, propertyKey, descriptor) => void)
Parameters
- cmd: string
Returns ((target, propertyKey, descriptor) => void)
- - (target, propertyKey, descriptor): void
  - Parameters
    - target: any
    - propertyKey: string
    - descriptor: PropertyDescriptor
    Returns void
- Defined in bitnode/bitnode.ts:571

Class Bitnode

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

apiUrl: string

Optional domain: Domain

Optional gateway: Gateway

Returns Bitnode

Properties

Private _closeWs

Private Optional _domain

Private _gateway

Private _holograms

Private _queries

Private _requests

Private Optional _ws

Private apiUrl

Private cbs

Static Private _handlers

Type declaration

Parameters

payload: SerializedType

Returns Promise<SerializedType>

Static Private _instance

Static models

Accessors

domain

Returns undefined | Domain

gateway

Returns Gateway

Static Private instance

Parameters

bitnode: undefined | Bitnode

Returns void

Methods

connect

Returns Promise<void>

Private createClassHologram

Parameters

clazz: string

Optional values: Serialized<ValueType>

Returns Promise<InternalHologram>

Private createModelHologram

Parameters

model: string

Optional values: Serialized<ValueType>

Returns Promise<InternalHologram>

deleteHologram

Parameters

hologramId: string

Returns Promise<void>

disconnect

Returns Promise<void>

Private gatewayEmitHologramValue

Parameters

payload: SerializedType

Returns Promise<SerializedType>

Private gatewayGetBlueprint

Parameters

payload: SerializedType

Returns Promise<SerializedType>

Private gatewayGetBlueprints

Parameters

payload: SerializedType

Returns Promise<SerializedType>

Private gatewayGetName

Parameters

payload: SerializedType

Returns Promise<SerializedType>

Private gatewayGetPlugin

Parameters

payload: SerializedType

Returns Promise<SerializedType>

Private gatewayGetVersion

Parameters

`Optional` domain: Domain

`Optional` gateway: Gateway

`Private` _closeWs

`Private` `Optional` _domain

`Private` _gateway

`Private` _holograms

`Private` _queries

`Private` _requests

`Private` `Optional` _ws

`Private` apiUrl

`Private` cbs

`Static` `Private` _handlers

`Static` `Private` _instance

`Static` models

`Static` `Private` instance

`Private` createClassHologram

`Optional` values: Serialized<ValueType>

`Private` createModelHologram

`Optional` values: Serialized<ValueType>

`Private` gatewayEmitHologramValue

`Private` gatewayGetBlueprint

`Private` gatewayGetBlueprints

`Private` gatewayGetName

`Private` gatewayGetPlugin

`Private` gatewayGetVersion

`Private` gatewayInvoke

`Private` gatewayInvokeDirect

`Private` gatewayLoad

`Private` gatewayModel

`Private` gatewayQueryAdd

`Private` gatewayQueryInitialDone

`Private` gatewayQueryRemove

`Private` gatewaySetHologramValue

`Private` gatewayStart

`Private` gatewayStop

`Private` gatewayUpdate

meta: {
class: string;
gateway: string;
model: string;
}