Class Typevine

Hierarchy

Typevine

Index

Constructors

constructor

Properties

Methods

Object literals

events

Constructors

constructor

new Typevine(supports: string[], userAgent?: string, version?: string): Typevine

- Defined in index.ts:57
Parameters
- supports: string[]
- Default value userAgent: string = "Typevine 0.0.1-dev"
- Default value version: string = "2.3.0"
Returns Typevine

Properties

Private channels

channels: string[] = []

Private eventCache

eventCache: object

Type declaration

[key: string]: Resolver

Private refCache

refCache: Map<string, Resolver> = new Map()

Private Optional restart

restart: number

Private socket

socket: WebSocket | null = null

Private supports

supports: string[]

userAgent

userAgent: string

version

version: string

Methods

authenticate

authenticate(id: string, secret: string): Promise<Core.IAuthResult>

- Defined in index.ts:68
Parameters
- id: string
- secret: string
Returns Promise<Core.IAuthResult>

broadcast

broadcast(channel: string, name: string, message: string): Promise<IResult>

- Defined in index.ts:136
Parameters
- channel: string
- name: string
- message: string
Returns Promise<IResult>

createAchievement

createAchievement(achievement: IAchievementCreate): Promise<IResult>

- Defined in index.ts:174
Parameters
- achievement: IAchievementCreate
Returns Promise<IResult>

deleteAchievement

deleteAchievement(key: string): Promise<IResultDelete>

- Defined in index.ts:190
Parameters
- key: string
Returns Promise<IResultDelete>

gameStatus

gameStatus(game: string): Promise<IResult<IStatus>>

- Defined in index.ts:126
Parameters
- game: string
Returns Promise<IResult<IStatus>>

heartbeat

heartbeat(players?: string[]): void

- Defined in index.ts:89
Parameters
- Optional players: string[]
Returns void

playerStatus

playerStatus(): void

- Defined in index.ts:121
Returns void

send

send(from: string, to: string, game: string, message: string): Promise<IResult>

- Defined in index.ts:150
Parameters
- from: string
- to: string
- game: string
- message: string
Returns Promise<IResult>

Private sendToVine

sendToVine(data: IObjectAny): boolean

- Defined in index.ts:309
Parameters
- data: IObjectAny
Returns boolean

Private sendWithRef

sendWithRef<T>(data: IObjectAny): Promise<T>

- Defined in index.ts:322
Type parameters
- T
Parameters
- data: IObjectAny
Returns Promise<T>

setChannels

setChannels(channels: string[]): void

- Defined in index.ts:65
Parameters
- channels: string[]
Returns void

Private setupSocket

setupSocket(): Promise<void>

- Defined in index.ts:200
Returns Promise<void>

signIn

signIn(name: string): Promise<IResult>

- Defined in index.ts:105
Parameters
- name: string
Returns Promise<IResult>

signOut

signOut(name: string): Promise<IResult>

- Defined in index.ts:113
Parameters
- name: string
Returns Promise<IResult>

subscribe

subscribe(channel: string): Promise<IResult>

- Defined in index.ts:81
Parameters
- channel: string
Returns Promise<IResult>

syncAchievements

syncAchievements(): Promise<IResult<IAchievementResponse[]>>

- Defined in index.ts:167
Returns Promise<IResult<IAchievementResponse[]>>

unsubscribe

unsubscribe(channel: string): Promise<IResult>

- Defined in index.ts:97
Parameters
- channel: string
Returns Promise<IResult>

updateAchievement

updateAchievement(update: IAchievementUpdate): Promise<IResult>

- Defined in index.ts:182
Parameters
- update: IAchievementUpdate
Returns Promise<IResult>

Private waitEvent

waitEvent<T>(event: string, data: object): Promise<T>

- Defined in index.ts:336
Type parameters
- T
Parameters
- event: string
- data: object
Returns Promise<T>

Object literals

events

events: object

channels

channels: EventEmitter<IEvents> = new EE()

core

core: EventEmitter<IEvents> = new EE()

games

games: EventEmitter<IEvents> = new EE()

players

players: EventEmitter<IEvents> = new EE()

tells

tells: EventEmitter<IEvents> = new EE()

Generated using TypeDoc