CODEWITHSUNDEEP
javascriptreferencetypescript
user1160771
user1160771

Reputation: 395

Reference javascript file inside typescript

I would like to use a javascript function inside a typescript file. How can I reference the javascript file containing that function inside typescript file?

I tried 

<reference path="../libs/myjsfile.js" />

this brings an error while building like: Cannot resolve referenced file: ../libs/myjsfile.js

Upvotes: 36

Views: 56262

Answers (4)

Roman
Roman

Reputation: 2175

You can see the latest version of the TypeScript documenttion in TypeScript Handbook on GitHub:

Also I am recomending you the tsd utility to search and install TypeScript definition files directly from the community driven DefinitelyTyped repository. This repository contains definition files *.d.ts for the most popular javascript libraries.

Upvotes: 1

user799755
user799755

Reputation:

While the two answers above will work for a small or single variable API, the correct answer is to write a type declaration file for your JavaScript file.

The type declaration file for your example would be named myjsfile.d.ts, where the .d.ts suffix is what tells the TypeScript compiler that it's parsing a declaration file. If you use Visual Studio, your declaration file will be recognized by the TypeScript compiler as long as it is somewhere (anywhere) in the project you are working on.

Declaration files store metadata about JavaScript variables, functions and objects so the TypeScript compiler can do its job. If your JavaScript file happens to be a library or framework in common use, DefinitelyTyped is definitely the place to find the definition file you need.

If your JavaScript is your own work or less well known, you'll have to write your own type declaration file. See the section Writing .d.ts files in The TypeScript Handbook.

If the name declaration file sounds intimidating, don't worry - they are far easier to write than programs. Also, remember that you don't need to specify all metadata for your JavaScript file, just the functionality you need.

Let me know if you need any help!

Upvotes: 43

basarat
basarat

Reputation: 276259

this brings an error while building like: Cannot resolve referenced file: ../libs/myjsfile.js

Reference file tags are for TypeScript not JavaScript. You would load JavaScript using a script tag in your page (or something like requirejs).

To use the JavaScript from TypeScript you would declare the API of the javascript you want to use for TypeScript consumption (as AKR pointed out).

Upvotes: 0

A. K-R
A. K-R

Reputation: 2002

You just have to tell the compiler that the method exists outside typescript:

declare function myJavaScriptFunction(param1: number, param2: JQuery): void;

Be sure that the website loads all files needed, the normal js files and the js files that the typescript compiler generated

Upvotes: 9

Related Questions