how to write typescript definition file for this javascript library?

Question

I need call the following javascript:

var jslib = jslib || (function() {
var publicMethods = {
    encrypt: function (algorithm, keyHandle, buffer) {
        // implementation
    }
};

return publicMethods;
})();

I am new to typescript, can you please share what the typescript definition will look like for the javascript above and invoke pattern?

Thanks in advance.

zjk · Accepted Answer · 2016-10-19 03:05:34Z

1

I'm assuming the following directory structure

├── lib
│   ├── jslib.d.ts
│   └── jslib.js
├── src
    └── t.ts

jslib.js

var jslib = jslib || (function () {
  var publicMethods = {
    encript: function () {
      return
    }
  };

  return publicMethods;
})();

module.exports = jslib;

jslib.d.ts

declare namespace jslib {
  function encript(): void;
}

export = jslib;

t.ts

import jslib = require('../lib/jslib');

jslib.encript();

Check with node_modules/.bin/tsc --traceResolution

======== Resolving module '../lib/jslib' from '/home/zjk/dev/webnote/ts1/src/t.ts'. ========
Explicitly specified module resolution kind: 'NodeJs'.
Loading module as file / folder, candidate module location '/home/zjk/dev/webnote/ts1/lib/jslib'.
File '/home/zjk/dev/webnote/ts1/lib/jslib.ts' does not exist.
File '/home/zjk/dev/webnote/ts1/lib/jslib.tsx' does not exist.
File '/home/zjk/dev/webnote/ts1/lib/jslib.d.ts' exist - use it as a name resolution result.
Resolving real path for '/home/zjk/dev/webnote/ts1/lib/jslib.d.ts', result '/home/zjk/dev/webnote/ts1/lib/jslib.d.ts'
======== Module name '../lib/jslib' was successfully resolved to '/home/zjk/dev/webnote/ts1/lib/jslib.d.ts'. ========

It is crucial to put jslib.js and jslib.d.ts in the same directory.

edited Oct 19, 2016 at 3:05

answered Oct 11, 2016 at 2:42

zjk

2,1633 gold badges28 silver badges48 bronze badges

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

5 Comments

Sky Line Over a year ago

Thanks zjk. I have two dumb questions 1) in javascript,how to understand var jslib = jslib || function(), I do not understand why jslib needs show up again after "=" 2) in your answer, what does const jslib mean? sorry, I am green to both scripts..

zjk Over a year ago

@SkyLine. Good questions! I'm no expert. I'll update in my answer

zjk Over a year ago

I have not tried my answer. I'll expand it later. As for var jslib = jslib || function(), it can prevent redefine the whole jslib if it is already defined.

Sky Line Over a year ago

Thanks @zjk. i am looking forward your update then :)

zjk Over a year ago

@SkyLine I must admit that I do not understand this issue well enough to answer this question. Sorry for the delay.

Collectives™ on Stack Overflow

how to write typescript definition file for this javascript library?

1 Answer 1

5 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Related