@types/node-osc - npm Package Compare versions

Comparing version 9.1.0 to 10.0.0

node-osc/index.d.cts

+/// <reference types="node" />
+
+import type { EventEmitter } from "events";
+
+/** Represents the content of a message */
+export interface Argument {
+    type: string;
+
+    value: boolean | number | string;
+}
+
+export type ArgumentType = boolean | number | string | Argument;
+
+export interface RequestInfo {
+    address: string;
+    family: string;
+    port: number;
+    size: number;
+}
+
+/**
+ * A message that can be sent over OSC
+ */
+export class Message {
+    constructor(address: string, ...args: ArgumentType[]);
+
+    append(arg: ArgumentType | ArgumentType[]): void;
+}
+
+/** Something that is or can be converted to a Message */
+export type MessageLike =
+    | [string, ...ArgumentType[]]
+    | {
+        address: string;
+
+        args: ArgumentType[];
+    };
+
+/**
+ * An OSC Bundle message
+ *
+ * @warning Bundle support is Experimental and subject to change at any point.
+ *
+ * @see https://github.com/MylesBorins/node-osc#sending-osc-bundles
+ */
+export class Bundle {
+    constructor(...elements: MessageLike[]);
+    constructor(timetag: number, ...elements: MessageLike[]);
+
+    append(element: MessageLike | Bundle): void;
+
+    timetag: number;
+
+    elements: Message[];
+}
+
+export type ClientSendArgs = Array<ArgumentType | Message | MessageLike>;
+
+export type ClientSendCallback = (err: Error | null) => void;
+
+export type ClientCloseCallback = () => void;
+
+/**
+ * A client to send messages to an OSC server
+ */
+export class Client {
+    constructor(host: string, port: number);
+
+    /** Close the underlying socket */
+    close(cb?: ClientCloseCallback): void;
+
+    /** Send a message to the server */
+    send(addressOrMessage: string | Message | MessageLike): void;
+    send(address: string, ...args: ClientSendArgs): void;
+    send(address: string, ...args: [...ClientSendArgs, ClientSendCallback]): void;
+    send(...args: ClientSendArgs): void;
+    send(...args: [...ClientSendArgs, ClientSendCallback]): void;
+
+    /** Send a Bundle message to the server */
+    send(bundle: Bundle, callback?: ClientSendCallback): void;
+}
+
+export type ServerCallback = () => void;
+
+export type ServerBundleListener = (bundle: Bundle) => void;
+
+export type ServerErrorListner = (error: Error) => void;
+
+export type ServerMessageListener = (message: [string, ...ArgumentType[]], rinfo: RequestInfo) => void;
+
+/**
+ * A server to handle OSC messages
+ */
+export class Server extends EventEmitter {
+    constructor(port: number, host: string, cb?: ServerCallback);
+
+    close(cb?: ServerCallback): void;
+
+    /** Listen for the listening event emitted as soon as the server is ready to receive messages */
+    on(event: "listening", listener: () => void): this;
+
+    /**
+     * Listen for all the bundles received by the server.
+     *
+     * @warning Bundle support is Experimental and subject to change at any point.
+     *
+     * @see https://github.com/MylesBorins/node-osc#listening-for-osc-bundles
+     */
+    on(event: "bundle", listener: ServerBundleListener): this;
+
+    /** Listen for errors occurred during message decoding */
+    on(event: "error", listener: ServerErrorListner): this;
+
+    /** Listen for all the messages received by the server or for a specific address */
+    on(event: "message" | string, listener: ServerMessageListener): this;
+}

node-osc/package.json

 {
     "name": "@types/node-osc",
-    "version": "9.1.0",
+    "version": "10.0.0",
     "description": "TypeScript definitions for node-osc",
@@ -14,4 +14,12 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-osc",
     ],
+    "type": "module",
     "main": "",
     "types": "index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./index.d.ts",
+            "require": "./index.d.cts"
+        },
+        "./package.json": "./package.json"
+    },
     "repository": {
@@ -27,4 +35,4 @@ "type": "git",
     "peerDependencies": {},
-    "typesPublisherContentHash": "310d43197e6280d46a9414b1dd5bca454a1452edd51fc81fa5d290261aaa067f",
-    "typeScriptVersion": "5.0"
+    "typesPublisherContentHash": "ac6527a768bff46dfe9adf6a2bb708434b3a1ddb182d897ec65060132924ebef",
+    "typeScriptVersion": "5.3"
 }

node-osc/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 28 Feb 2025 00:04:06 GMT
+ * Last updated: Tue, 07 Apr 2026 22:11:24 GMT
  * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
@@ -14,0 +14,0 @@

No alert changes

Improved metrics

Total package byte prevSize

9216

59.72%

Number of package files

5

25%

Is type module

Yes

NaN

No dependency changes