@geckos.io/common - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

lib/bridge.d.ts

@@ -0,0 +0,0 @@ import { ChannelId, Data, EventName, EventOptions, RoomId } from './types.js';

lib/bridge.js

@@ -0,0 +0,0 @@ import { Events } from '@yandeu/events';

lib/constants.d.ts

@@ -0,0 +0,0 @@ declare const EVENTS: {

lib/constants.js

@@ -0,0 +0,0 @@ const EVENTS = {

lib/helpers.d.ts

@@ -0,0 +0,0 @@ import { Data } from './types.js';

lib/helpers.js

@@ -0,0 +0,0 @@ import { ArrayBufferView } from './types.js';

lib/iceServers.d.ts

@@ -0,0 +0,0 @@ /**

lib/iceServers.js

@@ -0,0 +0,0 @@ /**

lib/makeRandomId.d.ts

 declare const makeRandomId: (length?: number) => string;
 export default makeRandomId;
 //# sourceMappingURL=makeRandomId.d.ts.map

lib/makeRandomId.js

@@ -0,0 +0,0 @@ const makeRandomId = (length = 24) => {

lib/parseMessage.d.ts

@@ -0,0 +0,0 @@ declare const ParseMessage: (ev: MessageEvent) => {

lib/parseMessage.js

@@ -0,0 +0,0 @@ import { ERRORS, EVENTS } from './constants.js';

lib/reliableMessage.d.ts

 declare const makeReliable: (options: any, cb: Function) => void;
 export { makeReliable };
 //# sourceMappingURL=reliableMessage.d.ts.map

lib/reliableMessage.js

@@ -0,0 +0,0 @@ import makeRandomId from './makeRandomId.js';

lib/runInterval.d.ts

 declare const runInterval: (interval: number | undefined, runs: number | undefined, cb: Function) => void;
 export default runInterval;
 //# sourceMappingURL=runInterval.d.ts.map

lib/runInterval.js

@@ -0,0 +0,0 @@ const runInterval = (interval = 200, runs = 1, cb) => {

lib/sendMessage.d.ts

@@ -0,0 +0,0 @@ import { Data, EventName, RawMessage } from './types.js';

lib/sendMessage.js

@@ -0,0 +0,0 @@ import { isBufferMessage, isStringMessage } from './helpers.js';

lib/types.d.ts

@@ -14,2 +14,3 @@ /// <reference types="node" />
 export declare type USVString = string;
+/** The geckos.io server options. */
 export interface ServerOptions {
@@ -23,12 +24,17 @@ /**
     authorization?: (auth: string | undefined, request: IncomingMessage, response: OutgoingMessage) => Promise<boolean | any>;
+    /** By default, geckos.io manages RTCDataChannel buffering for you. Default 'true' */
     autoManageBuffering?: boolean;
+    /** Set the CORS options. */
     cors?: CorsOptions;
+    /** An array of RTCIceServers. See https://developer.mozilla.org/en-US/docs/Web/API/RTCIceServer. */
     iceServers?: RTCIceServer[];
-    /** @deprecated since version 2.0 (not available in node-datachannel) */
+    /** RTCIceTransportPolicy enum defines string constants which can be used to limit the transport policies of the ICE candidates to be considered during the connection process. */
     iceTransportPolicy?: RTCIceTransportPolicy;
+    /** A human-readable name for the channel. This string may not be longer than 65,535 bytes. Default: 'geckos.io'. */
     label?: string;
-    /** @deprecated since version 2.0 (not available in node-datachannel) */
+    /** The maximum number of milliseconds that attempts to transfer a message may take in unreliable mode. While this value is a 16-bit unsigned number, each user agent may clamp it to whatever maximum it deems appropriate. Default: undefined. */
     maxPacketLifeTime?: number;
-    /** @deprecated since version 2.0 (not available in node-datachannel) */
+    /** options.maxRetransmits The maximum number of times the user agent should attempt to retransmit a message which fails the first time in unreliable mode. While this value is a16-bit unsigned number, each user agent may clamp it to whatever maximum it deems appropriate. Default: 0. */
     maxRetransmits?: number;
+    /** Indicates whether or not messages sent on the RTCDataChannel are required to arrive at their destination in the same order in which they were sent (true), or if they're allowed to arrive out-of-order (false). Default: false. */
     ordered?: boolean;
@@ -57,4 +63,7 @@ /** Set a custom port range for the WebRTC connection. */
 declare type CorsOptionsOriginFunction = (req: IncomingMessage) => string;
+/** The CORS options. */
 export interface CorsOptions {
+    /** Required if the client and server are on separate domains. Default: false */
     allowAuthorization?: boolean;
+    /** String OR (req: http.IncomingMessage) => string. Default '*' */
     origin: string | CorsOptionsOriginFunction;
@@ -61,0 +70,0 @@ }

lib/types.js

 const ArrayBufferView = Object.getPrototypeOf(Object.getPrototypeOf(new Uint8Array())).constructor;
 export { ArrayBufferView };
 //# sourceMappingURL=types.js.map

package.json

 {
   "name": "@geckos.io/common",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "The common module for @geckos.io/server and @geckos.io/client.",
@@ -5,0 +5,0 @@ "main": "lib",

README.md

@@ -0,0 +0,0 @@ # @geckos.io/common

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26451

increased by4.2%

Lines of code

350

increased by2.64%

No dependency changes