typescript make a simple d.ts file for npm package

Question

I'm trying to declare a .d.ts file to use npm uuid in an agular 2 app. What I'm doing seems to be in line with the example I found, yet I get the error : typescript d.ts file has no exported members v1

uuid/v1.d.ts file:

declare var v1: any;

declare module "uuid/v1" {
    export = v1;
}

the npm js file is uuid/v1.js:

function v1(options, buf, offset) { //...}

module.exports = v1;

I also tried :

export = uuid;
declare namespace uuid {
  function v1(): any;
}

which gives a runtime exception:

ORIGINAL EXCEPTION: __webpack_require__.i(...) is not a function

How are your importing it?

Aluan Haddad
– Aluan Haddad

2017-02-04 05:55:18 +00:00
Commented Feb 4, 2017 at 5:55 — Aluan Haddad
– Aluan Haddad, Commented Feb 4, 2017 at 5:55
@AluanHaddad like this import { v1 } from 'uuid/v1';

Ced
– Ced

2017-02-04 10:11:38 +00:00
Commented Feb 4, 2017 at 10:11 — Ced
– Ced, Commented Feb 4, 2017 at 10:11
You need to export the function from the namespace.

Aluan Haddad
– Aluan Haddad

2017-02-05 08:22:52 +00:00
Commented Feb 5, 2017 at 8:22 — Aluan Haddad
– Aluan Haddad, Commented Feb 5, 2017 at 8:22

craig · Accepted Answer · 2017-02-04 06:57:31Z

1

I am assuming this will be similar to how I wrote a DefinitelyTyped file. See @types/selenium-webdriver.

declare namespace uuid {
  interface V1Options {
    /**
     * Node id as Array of 6 bytes (per 4.1.6).
     * Default: Randomly generated ID.
     */
    node?: Array<any>;
    /**
     * Number between 0 - 0x3fff. RFC clock sequence.
     * Default: An internally maintained clockseq is used
     */
    clockseq?: number;
    /**
     * Time in milliseconds since unix Epoch.
     * Default: The current time is used.
     */
    msecs: number|Date;
    /**
     * Number between 0-9999) additional time, in 100-nanosecond units.
     * Ignored if msecs is unspecified. Default: internal uuid
     * counter is used, as per 4.2.1.2.
     */
    nsecs: number;
  };

  /**
   * Generate and return a RFC4122 v1 (timestamp-based) UUID.
   * @param {V1Options} options Optional uuid state to apply.
   * @param {Array<any>|Buffer} buffer Array or buffer where
   *        UUID bytes are to be written.
   * @param {number} offset Starting index in buffer at which to begin writing.
   */
  v1(options?: V1Options, buffer?: Array<any>|Buffer, offset?: number): Buffer;
}
export = uuid;

I believe you'll have to direct your tsconfig.json to use this file (or get it published to DefinitelyTyped) and then you can import {v1, V1Options} from 'uuid'; or import * from 'uuid';

answered Feb 4, 2017 at 6:57

craig

5,0161 gold badge25 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Ced Over a year ago

There is a couple errors there. after fixing those there is still an error at runtime.

craig Over a year ago

Do you have this in a github repo? I'll take a look at it this weekend.

Collectives™ on Stack Overflow

typescript make a simple d.ts file for npm package

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related