Class Api

Hierarchy

EventEmitter
- Api

Index

Constructors

constructor

Properties

Constructors

constructor

new Api(mesh: Mesh, storage?: MemoryStorage | MongodbStorage, options?: ApiOptions): Api

- Defined in core/api.ts:35
Parameters
- mesh: Mesh
- Optional storage: MemoryStorage | MongodbStorage
- Default value options: ApiOptions = {}
Returns Api

Properties

Private Optional checkReadyIntervalId

checkReadyIntervalId: NodeJS.Timer

Private logger

logger: Logger

Private mesh

mesh: Mesh

Private options

options: ApiOptions

Private Optional storage

storage: MemoryStorage | MongodbStorage

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1091
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Private checkMeshAndStorageReady

checkMeshAndStorageReady(): void

- Defined in core/api.ts:159
Returns void

close

close(): void

- Defined in core/api.ts:135
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1103
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1104
Returns Array<string | symbol>

getBlock

getBlock(height: number): Promise<any>

- Defined in core/api.ts:81
Parameters
- height: number
Returns Promise<any>

Private getBlockAndNodeMetaFromMesh

getBlockAndNodeMetaFromMesh(height: number): Promise<any>

- Defined in core/api.ts:212
Parameters
- height: number
Returns Promise<any>

getBlockCount

getBlockCount(): Promise<number>

- Defined in core/api.ts:58
Returns Promise<number>

Private getBlockCountFromMesh

getBlockCountFromMesh(): Promise<number>

- Defined in core/api.ts:193
Returns Promise<number>

Private getBlockFromMesh

getBlockFromMesh(height: number): Promise<any>

- Defined in core/api.ts:205
Parameters
- height: number
Returns Promise<any>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1100
Returns number

getTransaction

getTransaction(transactionId: string): Promise<any>

- Defined in core/api.ts:110
Parameters
- transactionId: string
Returns Promise<any>

Private getTransactionFromMesh

getTransactionFromMesh(transactionId: string): Promise<any>

- Defined in core/api.ts:226
Parameters
- transactionId: string
Returns Promise<any>

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1105
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1101
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1097
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1092
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1093
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1094
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1095
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1102
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1098
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1096
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1099
Parameters
- n: number
Returns this

Private storageInsertHandler

storageInsertHandler(payload: StorageInsertPayload): void

- Defined in core/api.ts:139
Parameters
- payload: StorageInsertPayload
Returns void

Private storeBlock

storeBlock(payload: StorageInsertPayload): void

- Defined in core/api.ts:184
Parameters
- payload: StorageInsertPayload
Returns void

Private storeBlockCount

storeBlockCount(payload: StorageInsertPayload): void

- Defined in core/api.ts:177
Parameters
- payload: StorageInsertPayload
Returns void

Private validateOptionalParameters

validateOptionalParameters(): void

- Defined in core/api.ts:155
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /Users/travis/ProjectGit/CityOfZion/neo-js/node_modules/@types/node/index.d.ts:1088
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc