@types/socketcluster-server - npm Package Compare versions

Comparing version 15.0.1 to 15.0.2

socketcluster-server/package.json

 {
     "name": "@types/socketcluster-server",
-    "version": "15.0.1",
+    "version": "15.0.2",
     "description": "TypeScript definitions for socketcluster-server",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/socketcluster-server",
     "license": "MIT",
@@ -33,4 +34,4 @@ "contributors": [
     },
-    "typesPublisherContentHash": "d317591b3ae94962655d85b660c9e52120a68c902d9d61d9eb3105bfb78ef307",
-    "typeScriptVersion": "2.8"
+    "typesPublisherContentHash": "63875f56186e9aad03174ab854842176b040458ac62fbedd179f7fb2ab6e1b63",
+    "typeScriptVersion": "3.6"
 }

socketcluster-server/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 14 Feb 2020 17:00:50 GMT
+ * Last updated: Tue, 06 Jul 2021 16:35:04 GMT
  * Dependencies: [@types/async-stream-emitter](https://npmjs.com/package/@types/async-stream-emitter), [@types/jsonwebtoken](https://npmjs.com/package/@types/jsonwebtoken), [@types/sc-auth](https://npmjs.com/package/@types/sc-auth), [@types/ws](https://npmjs.com/package/@types/ws), [@types/writable-consumable-stream](https://npmjs.com/package/@types/writable-consumable-stream), [@types/consumable-stream](https://npmjs.com/package/@types/consumable-stream), [@types/ag-simple-broker](https://npmjs.com/package/@types/ag-simple-broker), [@types/sc-broker-cluster](https://npmjs.com/package/@types/sc-broker-cluster), [@types/sc-errors](https://npmjs.com/package/@types/sc-errors), [@types/stream-demux](https://npmjs.com/package/@types/stream-demux)
@@ -14,0 +14,0 @@ * Global values: none

socketcluster-server/server.d.ts

@@ -27,5 +27,5 @@ import AsyncStreamEmitter = require('async-stream-emitter');
     allowClientPublish: boolean;
-    perMessageDeflate?: boolean | {};
+    perMessageDeflate?: boolean | {} | undefined;
     httpServer: Server;
-    socketChannelLimit?: number;
+    socketChannelLimit?: number | undefined;
     protocolVersion: 1 | 2;
@@ -36,10 +36,10 @@ strictHandshake: boolean;
     isReady: boolean;
-    signatureKey?: Secret;
-    verificationKey?: Secret;
+    signatureKey?: Secret | undefined;
+    verificationKey?: Secret | undefined;
     defaultVerificationOptions: {
-        algorithms?: string[];
+        algorithms?: string[] | undefined;
     };
     defaultSignatureOptions: {
         expiresIn: number;
-        algorithm?: string;
+        algorithm?: string | undefined;
     };
@@ -164,3 +164,3 @@ exchange: AGSimpleBroker.SimpleExchange;
         // with socketClusterServer.attach(...).
-        httpServer?: Server;
+        httpServer?: Server | undefined;
 
@@ -173,3 +173,3 @@ // This can be the name of an npm module or a path to a
         // instantiated.
-        wsEngineServerOptions?: WebSocket.ClientOptions;
+        wsEngineServerOptions?: WebSocket.ClientOptions | undefined;
 
@@ -181,3 +181,3 @@ // The key which SC will use to encrypt/decrypt authTokens,
         // authPrivateKey and authPublicKey instead of authKey.
-        authKey?: Secret;
+        authKey?: Secret | undefined;
 
@@ -190,3 +190,3 @@ // perMessageDeflate compression. Note that this option is
         // for messages > 1024 bytes.
-        perMessageDeflate?: boolean | {};
+        perMessageDeflate?: boolean | {} | undefined;
 
@@ -196,14 +196,14 @@ // If using an RSA or ECDSA algorithm to sign the
         // and authPublicKey in PEM format (string or Buffer).
-        authPrivateKey?: Secret;
-        authPublicKey?: Secret;
+        authPrivateKey?: Secret | undefined;
+        authPublicKey?: Secret | undefined;
 
         // The default expiry for auth tokens in seconds
-        authDefaultExpiry?: number;
+        authDefaultExpiry?: number | undefined;
 
         // The algorithm to use to sign and verify JWT tokens.
-        authAlgorithm?: string;
+        authAlgorithm?: string | undefined;
 
         // Can be 1 or 2. Version 1 is for maximum backwards
         // compatibility with SocketCluster clients.
-        protocolVersion?: 1 | 2;
+        protocolVersion?: 1 | 2 | undefined;
 
@@ -213,14 +213,14 @@ // In milliseconds - If the socket handshake hasn't been
         // connection attempt will be terminated.
-        handshakeTimeout?: number;
+        handshakeTimeout?: number | undefined;
 
         // In milliseconds, the timeout for receiving a response
         // when using invoke() or invokePublish().
-        ackTimeout?: number;
+        ackTimeout?: number | undefined;
 
         // Origins which are allowed to connect to the server.
-        origins?: string;
+        origins?: string | undefined;
 
         // The maximum number of unique channels which a single
         // socket can subscribe to.
-        socketChannelLimit?: number;
+        socketChannelLimit?: number | undefined;
 
@@ -230,7 +230,7 @@ // The interval in milliseconds on which to
         // it is still alive.
-        pingInterval?: number;
+        pingInterval?: number | undefined;
 
         // How many milliseconds to wait without receiving a ping
         // before closing the socket.
-        pingTimeout?: number;
+        pingTimeout?: number | undefined;
 
@@ -240,11 +240,11 @@ // Whether or not an error should be emitted on
         // middleware function
-        middlewareEmitFailures?: boolean;
+        middlewareEmitFailures?: boolean | undefined;
 
         // The URL path reserved by SocketCluster clients to
         // interact with the server.
-        path?: string;
+        path?: string | undefined;
 
         // Whether or not clients are allowed to publish messages
         // to channels.
-        allowClientPublish?: boolean;
+        allowClientPublish?: boolean | undefined;
 
@@ -255,3 +255,3 @@ // Whether or not to batch all socket messages
         // scenarios (e.g. batch resubscribe).
-        batchOnHandshake?: boolean;
+        batchOnHandshake?: boolean | undefined;
 
@@ -261,7 +261,7 @@ // If batchOnHandshake is true, this lets you specify
         // a successful socket handshake.
-        batchOnHandshakeDuration?: number;
+        batchOnHandshakeDuration?: number | undefined;
 
         // If batchOnHandshake is true, this lets you specify
         // the size of each batch in milliseconds.
-        batchInterval?: number;
+        batchInterval?: number | undefined;
 
@@ -276,8 +276,8 @@ // Lets you specify the default cleanup behaviour for
         // bebfore they are ended.
-        socketStreamCleanupMode?: 'kill' | 'close';
+        socketStreamCleanupMode?: 'kill' | 'close' | undefined;
 
-        authVerifyAlgorithms?: string[];
-        authEngine?: SCAuthEngine;
-        codecEngine?: CodecEngine;
-        cloneData?: boolean;
+        authVerifyAlgorithms?: string[] | undefined;
+        authEngine?: SCAuthEngine | undefined;
+        codecEngine?: CodecEngine | undefined;
+        cloneData?: boolean | undefined;
 
@@ -284,0 +284,0 @@ [additionalOptions: string]: any;

socketcluster-server/serversocket.d.ts

@@ -50,3 +50,3 @@ import { IncomingMessage } from 'http';
     remotePort: number;
-    forwardedForAddress?: string;
+    forwardedForAddress?: string | undefined;
 
@@ -68,4 +68,4 @@ isBufferingBatch: boolean;
     authState: 'authenticated' | 'unauthenticated';
-    authToken?: AGServerSocket.AuthToken;
-    signedAuthToken?: string;
+    authToken?: AGServerSocket.AuthToken | undefined;
+    signedAuthToken?: string | undefined;
 
@@ -166,3 +166,3 @@ constructor(id: string, server: AGServer, socket: WebSocket, protocolVersion: number);
 
-    send(data: any, options: { mask?: boolean; binary?: boolean; compress?: boolean; fin?: boolean }): void;
+    send(data: any, options: { mask?: boolean | undefined; binary?: boolean | undefined; compress?: boolean | undefined; fin?: boolean | undefined }): void;
 
@@ -210,3 +210,3 @@ decode(message: any): any;
     interface AuthTokenOptions extends SignOptions {
-        rejectOnFailedDelivery?: boolean;
+        rejectOnFailedDelivery?: boolean | undefined;
     }
@@ -217,11 +217,11 @@
         newState: 'authenticated' | 'unauthenticated';
-        authToken?: AuthToken;
+        authToken?: AuthToken | undefined;
     }
 
     interface AuthenticateData {
-        authToken?: AuthToken;
+        authToken?: AuthToken | undefined;
     }
 
     interface DeauthenticateData {
-        oldAuthToken?: AuthToken;
+        oldAuthToken?: AuthToken | undefined;
     }
@@ -237,3 +237,3 @@
         pingTimeout: number;
-        authError?: Error;
+        authError?: Error | undefined;
         isAuthenticated: boolean;
@@ -249,3 +249,3 @@ }
         channel: string;
-        waitForAuth?: boolean;
+        waitForAuth?: boolean | undefined;
         data?: any;
@@ -252,0 +252,0 @@ }

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25074

2.48%

Number of low quality alerts

0

-100%

No dependency changes