Typescript typings

[makarov-roman]

Hi,
it would be great to have typescript types.

[josdejong]

Would be nice if you can crate typescript definitions, thanks for the offer Makarov. Can you create a pull request in https://github.com/DefinitelyTyped/DefinitelyTyped?

[dbachrach]

This might be useful for anyone else:

declare module "timesync" {
  type TimeSync = {
    destroy();
    now(): number;
    on(event: "change", callback: (offset: number) => void);
    on(event: "error", callback: (err: any) => void);
    on(event: "sync", callback: (value: "start" | "end") => void);
    off(event: "change" | "error" | "sync", callback?: () => void);
    sync();

    send(to: string, data: object, timeout: number): Promise<void>;
    receive(from: string, data: object);
  };

  type TimeSyncCreateOptions = {
    interval?: number;
    timeout?: number;
    delay?: number;
    repeat?: number;
    peers?: string | string[];
    server?: string;
    now?: () => number;
  };

  function create(options: TimeSyncCreateOptions): TimeSync;
}

[rgolea]

To complete @dbachrach's response, I've added the server side typings as well:

declare module "timesync" {
  type TimeSync = {
    destroy();
    now(): number;
    on(event: "change", callback: (offset: number) => void);
    on(event: "error", callback: (err: any) => void);
    on(event: "sync", callback: (value: "start" | "end") => void);
    off(event: "change" | "error" | "sync", callback?: () => void);
    sync();

    send(to: string, data: object, timeout: number): Promise<void>;
    receive(from: string, data: object);
  };

  type TimeSyncCreateOptions = {
    interval?: number;
    timeout?: number;
    delay?: number;
    repeat?: number;
    peers?: string | string[];
    server?: string;
    now?: () => number;
  };

  function create(options: TimeSyncCreateOptions): TimeSync;

  export = TimeSync;
}

declare module 'timesync/server' {
  import type { Request as ExpressRequest, Response as ExpressResponse } from 'express';
  import type { createServer as createHttpServer, Server } from 'http';
  function requestHandler(req: Request | ExpressRequest, res: Response | ExpressResponse): void;

  function createServer(): ReturnType<typeof createHttpServer>;

  function attachServer(server: Server, path?: string): void;
}

Could we implement this in a PR?

We just need to add a typings field in package.json and make sure we point to the .d.ts file:

{
    "name": "timesync",
    "typings": "./typings.d.ts",
    ...
}

[nonotnoah]

@rgolea I followed your steps but I can't get it to work for me. I'm trying to import for use with socket.io.

I did:

• npm i timesync
• added typings.d.ts to the npm package folder
• changed package.json to point at ./typings.d.ts
• added `import timesync from 'timesync' to my client.tsx file

at this point the import errors complaining about types goes away, but when I try to actually use the module with const ts = timesync.create, Intellisense complains that "'timesync' only refers to a type, but is being used as a value here."

It seems like timesync is using the type declarations in typings.d.ts, but isn't using node_modules/timesync for the actual code.

[crossan007]

@nonotnoah I get the same issue.

[crossan007]

I took a different approach and refactored the whole source to TypeScript and configured tsc to emit type declarations https://github.com/crossan007/timesync