onAuth.md

onAuth (socket: ClientSocket, message: Buffer): Promise<void>

Description

This event is executed on the first message to prevent execution of actions before proper authentication. If this event throws an exception, the next client message will also be parsed by this event instead of calling an action in itself. To identify the user after authentication during onAuth an attribute called userData should be filled into the clientSocket object passed as a parameter. If that field is not filled during onAuth, the server will automatically add to the clientSocket object a random uuid string as the an id field inside of userData.

Parameters

• clientSocket: The user-identifying open socket.
• message: Message sent from the client with data expected to be used for authentication.

Usage:

// Assuming the existence of a "./actions" folder.

import { Socket } from "socket-actions/server";

new Socket({
    onAuth: (socket, message) => {
        if (message.data !== "42")
            throw new Error("You are not our guy.");
    }
});

// This will prevent anyone that hasn't sent a message with "42" from going forward and calling actions.