Class SupplementaryData

Used in generators to provide optional access to other spans, exchanges or quote types

Hierarchy (View Summary)

chartbreaker.EventEmitter<SupplementaryData_Events>
- SupplementaryData

Index

Constructors

constructor

new SupplementaryData(context: TContext): SupplementaryData
Parameters
- context: TContext
Returns SupplementaryData
Overrides EventEmitter.constructor

Properties

`Optional` `Readonly`events

events?: SupplementaryData_Events

Description

Phantom data for type inference

Methods

addListener

addListener<
    Type extends keyof SupplementaryData_Events,
    Callback extends

            | (() => void)
            | (
                (
                    errors: null | Record<string, ChartbreakerError>,
                    pushStates: Record<
                        string,
                        ChartbreakerError
                        | boolean
                        | DataLoaderTPush
                        | null,
                    >,
                ) => void
            )
            | (() => void),
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends keyof SupplementaryData_Events
- Callback extends
      | (() => void)
      | (
          (
              errors: null | Record<string, ChartbreakerError>,
              pushStates: Record<
                  string,
                  ChartbreakerError
                  | boolean
                  | DataLoaderTPush
                  | null,
              >,
          ) => void
      )
      | (() => void)
Parameters
- type: Type
- listener: Callback
Returns this
Description
adds a listener to the end of the listeners array for the specified event.

Inherited from EventEmitter.addListener

emit

emit<
    Type extends keyof SupplementaryData_Events,
    Callback extends

            | (() => void)
            | (
                (
                    errors: null | Record<string, ChartbreakerError>,
                    pushStates: Record<
                        string,
                        ChartbreakerError
                        | boolean
                        | DataLoaderTPush
                        | null,
                    >,
                ) => void
            )
            | (() => void),
>(
    type: Type,
    ...params: Parameters<Callback>,
): boolean
Type Parameters
- Type extends keyof SupplementaryData_Events
- Callback extends
      | (() => void)
      | (
          (
              errors: null | Record<string, ChartbreakerError>,
              pushStates: Record<
                  string,
                  ChartbreakerError
                  | boolean
                  | DataLoaderTPush
                  | null,
              >,
          ) => void
      )
      | (() => void)
Parameters
- type: Type
- ...params: Parameters<Callback>
Returns boolean
Description
execute each of the listeners in order with the supplied parameters.

Inherited from EventEmitter.emit

getIndentifierByIndex

getIndentifierByIndex(span: ESpans, identifier: number): number
returns the index for the specified identifier in the data source for a particular span
Parameters
- span: ESpans
  the span to perform the lookup on
- identifier: number
  an identifier unix timestamp
Returns number
an identifier

getIndexByIdentifier

getIndexByIdentifier(span: ESpans, index: number): number
returns the identifier for the specified index in the data source for a particular span
Parameters
- span: ESpans
  the span to perform the lookup on
- index: number
  an index
Returns number
an identifier unix timestamp

listeners

listeners<
    Type extends keyof SupplementaryData_Events,
    Callback extends

            | (() => void)
            | (
                (
                    errors: null | Record<string, ChartbreakerError>,
                    pushStates: Record<
                        string,
                        ChartbreakerError
                        | boolean
                        | DataLoaderTPush
                        | null,
                    >,
                ) => void
            )
            | (() => void),
>(
    type: Type,
): Callback[]
Type Parameters
- Type extends keyof SupplementaryData_Events
- Callback extends
      | (() => void)
      | (
          (
              errors: null | Record<string, ChartbreakerError>,
              pushStates: Record<
                  string,
                  ChartbreakerError
                  | boolean
                  | DataLoaderTPush
                  | null,
              >,
          ) => void
      )
      | (() => void)
Parameters
- type: Type
Returns Callback[]
Description
returns an array of listeners for the specified event.

Inherited from EventEmitter.listeners

on

on<
    Type extends keyof SupplementaryData_Events,
    Callback extends

            | (() => void)
            | (
                (
                    errors: null | Record<string, ChartbreakerError>,
                    pushStates: Record<
                        string,
                        ChartbreakerError
                        | boolean
                        | DataLoaderTPush
                        | null,
                    >,
                ) => void
            )
            | (() => void),
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends keyof SupplementaryData_Events
- Callback extends
      | (() => void)
      | (
          (
              errors: null | Record<string, ChartbreakerError>,
              pushStates: Record<
                  string,
                  ChartbreakerError
                  | boolean
                  | DataLoaderTPush
                  | null,
              >,
          ) => void
      )
      | (() => void)
Parameters
- type: Type
- listener: Callback
Returns this
Description
alias for addListener

Inherited from EventEmitter.on

once

once<
    Type extends keyof SupplementaryData_Events,
    Callback extends

            | (() => void)
            | (
                (
                    errors: null | Record<string, ChartbreakerError>,
                    pushStates: Record<
                        string,
                        ChartbreakerError
                        | boolean
                        | DataLoaderTPush
                        | null,
                    >,
                ) => void
            )
            | (() => void),
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends keyof SupplementaryData_Events
- Callback extends
      | (() => void)
      | (
          (
              errors: null | Record<string, ChartbreakerError>,
              pushStates: Record<
                  string,
                  ChartbreakerError
                  | boolean
                  | DataLoaderTPush
                  | null,
              >,
          ) => void
      )
      | (() => void)
Parameters
- type: Type
- listener: Callback
Returns this
Description
adds a one time listener for the event. This listener is invoked only the next time the event is fired, after which it is removed.

Inherited from EventEmitter.once

removeAllListeners

removeAllListeners<Type extends keyof SupplementaryData_Events>(
type?: Type,
): this
Type Parameters
- Type extends keyof SupplementaryData_Events
Parameters
- Optionaltype: Type
Returns this
Description
removes all listeners, or those of the specified event.

Inherited from EventEmitter.removeAllListeners

removeListener

removeListener<
    Type extends keyof SupplementaryData_Events,
    Callback extends

            | (() => void)
            | (
                (
                    errors: null | Record<string, ChartbreakerError>,
                    pushStates: Record<
                        string,
                        ChartbreakerError
                        | boolean
                        | DataLoaderTPush
                        | null,
                    >,
                ) => void
            )
            | (() => void),
>(
    type: Type,
    listener: Callback,
): this
Type Parameters
- Type extends keyof SupplementaryData_Events
- Callback extends
      | (() => void)
      | (
          (
              errors: null | Record<string, ChartbreakerError>,
              pushStates: Record<
                  string,
                  ChartbreakerError
                  | boolean
                  | DataLoaderTPush
                  | null,
              >,
          ) => void
      )
      | (() => void)
Parameters
- type: Type
- listener: Callback
Returns this
Description
remove a listener from the listener array for the specified event.

Inherited from EventEmitter.removeListener

requestOHLCSet

requestOHLCSet(
    dependantId: number,
    identifier: string,
    span: ESpans,
): Promise<
    Result<
        { metaData: DataLoaderTMetaData; ohlc: DataTOHLCSet },
        { err: ChartbreakerError },
    >,
>
Get's the OHLC set for an identifier by the provided span. If it doesn't exist, it will be created.
Parameters
- dependantId: number
- identifier: string
- span: ESpans
Returns Promise<
    Result<
        { metaData: DataLoaderTMetaData; ohlc: DataTOHLCSet },
        { err: ChartbreakerError },
    >,
>

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Description
by default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default which helps finding memory leaks. Obviously not all Emitters should be limited to 10. This function allows that limit to be increased. Set to zero for unlimited.

Inherited from EventEmitter.setMaxListeners

`Static`guard

guard(cb: GuardCb): void
Parameters
- cb: GuardCb
Returns void
Description
set custom error handler for event listeners

Inherited from EventEmitter.guard

`Static`listenerCount

listenerCount<EvType extends Events, Type extends string>(
emitter: chartbreaker.EventEmitter<EvType>,
type: Type,
): number
Type Parameters
- EvType extends Events
- Type extends string
Parameters
- emitter: chartbreaker.EventEmitter<EvType>
- type: Type
Returns number
Description
returns number of listeners on specified emitter for specified type

Inherited from EventEmitter.listenerCount

`Static`setDefaultMaxListeners

setDefaultMaxListeners(maxListeners: number): void
Parameters
- maxListeners: number
Returns void
Description
set default amount for limit warning

Inherited from EventEmitter.setDefaultMaxListeners

Class SupplementaryData

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SupplementaryData

Properties

Optional Readonlyevents

Description

Methods

addListener

Type Parameters

Parameters

Returns this

Description

emit

Type Parameters

Parameters

Returns boolean

Description

getIndentifierByIndex

Parameters

Returns number

getIndexByIdentifier

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns Callback[]

Description

on

Type Parameters

Parameters

Returns this

Description

once

Type Parameters

Parameters

Returns this

Description

removeAllListeners

Type Parameters

Parameters

Returns this

Description

removeListener

Type Parameters

Parameters

Returns this

Description

requestOHLCSet

Parameters

Returns Promise< Result< { metaData: DataLoaderTMetaData; ohlc: DataTOHLCSet }, { err: ChartbreakerError }, >,>

setMaxListeners

Parameters

Returns this

Description

Staticguard

Parameters

Returns void

Description

StaticlistenerCount

Type Parameters

Parameters

Returns number

Description

StaticsetDefaultMaxListeners

Parameters

Returns void

Description

Settings

On This Page

`Optional` `Readonly`events

Returns Promise<
Result<
{ metaData: DataLoaderTMetaData; ohlc: DataTOHLCSet },
{ err: ChartbreakerError },
>,
>

`Static`guard

`Static`listenerCount

`Static`setDefaultMaxListeners