Variable default

Type declaration

• kws: {
      WsClient: typeof WsClient;
      serverClose: ((socket) => void);
      serverHandle: ((socket, buffer) => any);
      serverSend: ((socket, obj) => void);
  }

  • WsClient: typeof WsClient

  • serverClose: ((socket) => void)

    • • (socket): void

      • Parameters

        • socket: any

        Returns void

  • serverHandle: ((socket, buffer) => any)

    • • (socket, buffer): any

      • Tiny server handle addon function

        Example::

        import { WebSocketServer } from 'ws'; import { kws } from 'k1js';

        const wss = new kws.WebSocketServer({ port: 8765 });

        wss.on('connection', (ws) => { console.log('Client connected');

        ws.on('message', (obj) => {
          const msg = kws.serverHandle(ws, obj) // can be undefined
          console.log(`Received message: ${msg}`);
          if (msg) kws.serverSend(ws, `modified msg (${msg})`) // optionally send a response back to the client
          // kws.serverClose(ws) // uncomment this if you want to close at any time
        });
        
        ws.on('close', () => {
          console.log('Client disconnected');
        });
        Copy

        });

        Parameters

        • socket: any

        • buffer: any

        Returns any

  • serverSend: ((socket, obj) => void)

    • • (socket, obj): void

      • Parameters

        • socket: any

        • obj: any

        Returns void

• log: ((path, obj) => void)

  • • (path, obj): void

    • Parameters

      • path: any

      • obj: any

      Returns void

• utils: {
      cyrb128: ((str) => number[]);
      deque: typeof deque;
      emptyFn: (() => number);
      emptyFn1Arg: ((e) => number);
      random: ((seed) => number);
      range: ((n) => number[]);
      shuffle: ((array, seed?) => any);
      sleep: ((s) => Promise<any>);
      wait_for: ((promise, timeout?) => Promise<any>);
  }

  • cyrb128: ((str) => number[])

    • • (str): number[]

      • Parameters

        • str: any

        Returns number[]

  • deque: typeof deque

  • emptyFn: (() => number)

    • • (): number

      • Returns number

  • emptyFn1Arg: ((e) => number)

    • • (e): number

      • Parameters

        • e: any

        Returns number

  • random: ((seed) => number)

    • • (seed): number

      • Parameters

        • seed: any

        Returns number

  • range: ((n) => number[])

    • • (n): number[]

      • Parameters

        • n: any

        Returns number[]

  • shuffle: ((array, seed?) => any)

    • • (array, seed?): any

      • Parameters

        • array: any

        • seed: any = null

        Returns any

  • sleep: ((s) => Promise<any>)

    • • (s): Promise<any>

      • Parameters

        • s: any

        Returns Promise<any>

  • wait_for: ((promise, timeout?) => Promise<any>)

    • • (promise, timeout?): Promise<any>

      • Parameters

        • promise: any

        • timeout: number = 1

        Returns Promise<any>