DefinitelyTyped/types/socketcluster-client/socketcluster-client-tests.ts

// Adapted from README

import { create } from 'socketcluster-client';

const socket = create({
    hostname: 'localhost',
    port: 8000,
});

socket.transmit('foo', 123);

(async () => {
    // $ExpectType number
    await socket.invoke('myProc', 123);
})();

(async () => {
    // Subscribe to a channel.
    const myChannel = socket.subscribe('myChannel');

    await myChannel.listener('subscribe').once();

    // $ExpectType ChannelState
    myChannel.state;
})();

(async () => {
    const myChannel = socket.channel('myChannel');

    myChannel.subscribe();
    await myChannel.listener('subscribe').once();

    // $ExpectType ChannelState
    myChannel.state;

    myChannel.transmitPublish('This is a message');
})();

socket.transmitPublish('myChannel', 'This is a message');

(async () => {
    const myChannel = socket.channel('myChannel');

    try {
        await myChannel.invokePublish('This is a message');
    } catch (error) {}

    try {
        const response = await socket.invokePublish('myChannel', 'This is a message');

        // $ExpectType string
        response.channel;

        // $ExpectType string
        response.data;
    } catch (error) {}
})();

(async () => {
    const myChannel = socket.channel('myChannel');

    // tslint:disable-next-line: await-promise Bug in tslint: https://github.com/palantir/tslint/issues/3997
    for await (const data of myChannel) {
        // $ExpectType any
        data;
    }
})();

(async () => {
    const secureOptions = {
        hostname: 'securedomain.com',
        secure: true,
        port: 443,
        rejectUnauthorized: false, // Only necessary during debug if using a self-signed certificate
    };

    const secureSocket = create(secureOptions);
    const authStatus = await secureSocket.authenticate('abc');

    // $ExpectType Error
    authStatus.authError;

    // $ExpectType AuthStates
    authStatus.isAuthenticated;
})();

const mostOptions = {
    path: '/socketcluster/',
    port: 8000,
    hostname: '127.0.0.1',
    autoConnect: true,
    secure: false,
    rejectUnauthorized: false,
    connectTimeout: 10000,
    ackTimeout: 10000,
    channelPrefix: null,
    disconnectOnUnload: true,
    autoReconnectOptions: {
        initialDelay: 10000,
        randomness: 10000,
        multiplier: 1.5,
        maxDelay: 60000,
    },
    authEngine: null,
    codecEngine: null,
    subscriptionRetryOptions: {},
    query: {
        yourparam: 'hello',
    },
};

create(mostOptions);

const oldVersionSocket = create({
    protocolVersion: 1,
    path: '/socketcluster/',
});

// $ExpectType ProtocolVersions
oldVersionSocket.protocolVersion;