Interface NashSocketEvents

Hierarchy

NashSocketEvents

Index

Properties

Methods

Properties

absintheSocket

absintheSocket: InstanceType<AbsintheSocket>

disconnect

disconnect: () => void

Type declaration

- (): void
- Returns void

socket

socket: InstanceType<PhoenixSocket>

See https://www.npmjs.com/package/phoenix-channels

Methods

onAccountTrade

onAccountTrade(variables: { marketName: string }, handlers: SubscriptionHandlers<{ data: { newAccountTrades: Trade[] } }>): void

- Defined in src/types/client.ts:129
Parameters
- variables: { marketName: string }
  - marketName: string
- handlers: SubscriptionHandlers<{ data: { newAccountTrades: Trade[] } }>
Returns void

onNewTrades

onNewTrades(variables: { marketName: string }, handlers: SubscriptionHandlers<{ data: { newTrades: Trade[] } }>): void

- Defined in src/types/client.ts:113
Parameters
- variables: { marketName: string }
  - marketName: string
- handlers: SubscriptionHandlers<{ data: { newTrades: Trade[] } }>
Returns void

onUpdatedAccountOrders

onUpdatedAccountOrders(variables: { buyOrSell?: OrderBuyOrSell; marketName?: string; rangeStart?: DateTime; rangeStop?: DateTime; status?: OrderStatus[]; type?: OrderType[] }, handlers: SubscriptionHandlers<{ data: { updatedAccountOrders: Order[] } }>): void

- Defined in src/types/client.ts:83
Parameters
- variables: { buyOrSell?: OrderBuyOrSell; marketName?: string; rangeStart?: DateTime; rangeStop?: DateTime; status?: OrderStatus[]; type?: OrderType[] }
  - Optional buyOrSell?: OrderBuyOrSell
  - Optional marketName?: string
  - Optional rangeStart?: DateTime
  - Optional rangeStop?: DateTime
  - Optional status?: OrderStatus[]
  - Optional type?: OrderType[]
- handlers: SubscriptionHandlers<{ data: { updatedAccountOrders: Order[] } }>
Returns void

onUpdatedCandles

onUpdatedCandles(variables: { interval: CandleInterval; marketName: string }, handlers: SubscriptionHandlers<{ data: { updatedCandles: CandleRange[] } }>): void

- Defined in src/types/client.ts:98
Parameters
- variables: { interval: CandleInterval; marketName: string }
  - interval: CandleInterval
  - marketName: string
- handlers: SubscriptionHandlers<{ data: { updatedCandles: CandleRange[] } }>
Returns void

onUpdatedOrderbook

onUpdatedOrderbook(variables: { marketName: string }, handlers: SubscriptionHandlers<{ data: { updatedOrderBook: OrderBook } }>): void

- Defined in src/types/client.ts:121
Parameters
- variables: { marketName: string }
  - marketName: string
- handlers: SubscriptionHandlers<{ data: { updatedOrderBook: OrderBook } }>
Returns void

onUpdatedTickers

onUpdatedTickers(handlers: SubscriptionHandlers<{ data: { updatedTickers: Ticker[] } }>): void

- Defined in src/types/client.ts:106
Parameters
- handlers: SubscriptionHandlers<{ data: { updatedTickers: Ticker[] } }>
Returns void

Generated using TypeDoc