@types/socketcluster-server
Advanced tools
Comparing version
{ | ||
"name": "@types/socketcluster-server", | ||
"version": "14.2.1", | ||
"version": "14.2.2", | ||
"description": "TypeScript definitions for socketcluster-server", | ||
@@ -27,4 +27,4 @@ "license": "MIT", | ||
}, | ||
"typesPublisherContentHash": "d75b8c5d19de38708083011c81ac894a78d94ec2a3db87c1674c0bbd3b3c95e9", | ||
"typesPublisherContentHash": "9625653fae0c6043cbb323bd7f36b47f5ea81f85ff04102eddf189c71a919e2e", | ||
"typeScriptVersion": "2.4" | ||
} |
@@ -5,3 +5,3 @@ # Installation | ||
# Summary | ||
This package contains type definitions for socketcluster-server (https://github.com/SocketCluster/socketcluster-server). | ||
This package contains type definitions for socketcluster-server ( https://github.com/SocketCluster/socketcluster-server ). | ||
@@ -12,3 +12,3 @@ # Details | ||
Additional Details | ||
* Last updated: Mon, 14 Jan 2019 20:57:16 GMT | ||
* Last updated: Wed, 30 Jan 2019 18:47:33 GMT | ||
* Dependencies: @types/jsonwebtoken, @types/sc-auth, @types/sc-broker-cluster, @types/ws, @types/component-emitter | ||
@@ -15,0 +15,0 @@ * Global values: none |
@@ -6,3 +6,3 @@ import { EventEmitter } from "events"; | ||
import { SCAuthEngine } from "sc-auth"; | ||
import { SCExchange } from "sc-broker-cluster"; | ||
import { SCExchange, Client } from "sc-broker-cluster"; | ||
import WebSocket = require("ws"); | ||
@@ -22,2 +22,3 @@ | ||
options: SCServer.SCServerOptions; | ||
brokerEngine: Client; | ||
exchange: SCExchange; | ||
@@ -63,3 +64,6 @@ | ||
setAuthEngine(authEngine: SCAuthEngine): void; | ||
auth: SCAuthEngine; | ||
setCodecEngine(codecEngine: SCServer.SCCodecEngine): void; | ||
codec: SCServer.SCCodecEngine; | ||
@@ -354,3 +358,3 @@ close(cb?: (err?: Error) => void): void; | ||
decode: (input: any) => any; | ||
ncode: (object: any) => any; | ||
encode: (object: any) => any; | ||
} | ||
@@ -357,0 +361,0 @@ |
@@ -32,9 +32,38 @@ import Emitter = require("component-emitter"); | ||
on(event: "error", listener: (error: Error) => void): this; | ||
on(event: "message" | "raw", listener: (message: WebSocket.Data) => void): this; | ||
on(event: "connectAbort" | "disconnect" | "close", listener: (code: number, data?: any) => void): this; | ||
on(event: "authStateChange", listener: (stateChangeData: SCServerSocket.StateChangeData) => void): this; | ||
on(event: "authenticate", listener: (authToken?: SCServer.AuthToken) => void): this; | ||
on(event: "deauthenticate", listener: (oldToken?: SCServer.AuthToken) => void): this; | ||
getState(): "connecting" | "open" | "closed"; | ||
getBytesReceived(): number; | ||
disconnect(code?: number, data?: any): void; | ||
destroy(code?: number, data?: any): void; | ||
terminate(): void; | ||
send(data: any, options: { mask?: boolean; binary?: boolean; compress?: boolean; fin?: boolean }): void; | ||
decode(message: any): any; | ||
encode(object: any): any; | ||
sendObjectBatch(object: any): void; | ||
sendObjectSingle(object: any): void; | ||
sendObject(object: any, options?: { batch?: boolean }): void; | ||
emit(event: string, ...args: any[]): boolean; | ||
emit(event: string, data: any, callback?: SCServerSocket.EmitCallback, options?: SCServerSocket.EmitOptions): void; | ||
triggerAuthenticationEvents(oldState: "authenticated" | "unauthenticated"): void; | ||
getAuthToken(): SCServer.AuthToken; | ||
setAuthToken(data: SCServer.AuthToken, options?: SignOptions): void; | ||
deauthenticate(): void; | ||
setAuthToken(data: SCServer.AuthToken, options?: SignOptions, callback?: SCServerSocket.EmitCallback): void; | ||
deauthenticateSelf(): void; | ||
deauthenticate(callback?: SCServerSocket.EmitCallback): void; | ||
kickOut(channel?: string, message?: string, callback?: () => void): void; | ||
subscriptions(): string[]; | ||
@@ -45,1 +74,22 @@ isSubscribed(channel?: string): boolean; | ||
export = SCServerSocket; | ||
declare namespace SCServerSocket { | ||
type EmitCallback = (err: Error, eventObject: EventObject) => void; | ||
interface EventObject { | ||
event: string; | ||
data?: any; | ||
cid?: number; | ||
} | ||
interface EmitOptions { | ||
useCache?: boolean; | ||
stringifiedData?: string; | ||
} | ||
interface StateChangeData { | ||
oldState: "authenticated" | "unauthenticated"; | ||
newState: "authenticated" | "unauthenticated"; | ||
authToken?: SCServer.AuthToken; | ||
} | ||
} |
22282
8.92%365
11.62%