Interface AlpacaStreamingFFI

Instance side of the native streaming classes. These must equal the classes napi generates in rust/index.d.ts; ffi-types.test.ts enforces that at typecheck time. Every method returns a promise.

interface AlpacaStreamingFFI {
    clean(): Promise<void>;
    init(config: AlpacaConfig): Promise<void>;
    start(): Promise<void>;
    stop(): Promise<void>;
    subscribe(opts: AlpacaSubscribeOpts): Promise<void>;
    unsubscribe(opts: AlpacaSubscribeOpts): Promise<void>;
}

Index

Methods

clean init start stop subscribe unsubscribe

Methods

clean

clean(): Promise<void>
Clean local state/database

Returns Promise<void>
- Defined in ts-core/src/core/ffi-types.ts:73

init

init(config: AlpacaConfig): Promise<void>
Initialize with config object
Parameters
- config: AlpacaConfig
Returns Promise<void>
- Defined in ts-core/src/core/ffi-types.ts:65

start

start(): Promise<void>
Start the streaming connection

Returns Promise<void>
- Defined in ts-core/src/core/ffi-types.ts:67

stop

stop(): Promise<void>
Stop the streaming connection

Returns Promise<void>
- Defined in ts-core/src/core/ffi-types.ts:75

subscribe(opts: AlpacaSubscribeOpts): Promise<void>
Subscribe to symbols per channel
Parameters
- opts: AlpacaSubscribeOpts
Returns Promise<void>
- Defined in ts-core/src/core/ffi-types.ts:69

unsubscribe

unsubscribe(opts: AlpacaSubscribeOpts): Promise<void>
Unsubscribe from symbols per channel
Parameters
- opts: AlpacaSubscribeOpts
Returns Promise<void>
- Defined in ts-core/src/core/ffi-types.ts:71