From a3327570434c296acc8b295323ec638364fd1b1d Mon Sep 17 00:00:00 2001 From: Kevan Stannard Date: Mon, 8 Mar 2021 18:40:36 +1100 Subject: [PATCH 1/3] Syntax lookup: external --- misc_docs/syntax/language_external.mdx | 36 ++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 misc_docs/syntax/language_external.mdx diff --git a/misc_docs/syntax/language_external.mdx b/misc_docs/syntax/language_external.mdx new file mode 100644 index 000000000..2d0e8bdad --- /dev/null +++ b/misc_docs/syntax/language_external.mdx @@ -0,0 +1,36 @@ +--- +id: "external" +keywords: ["external", "javascript"] +name: "external" +summary: "This is the `external` language construct." +category: "languageconstructs" +--- + +`external` is used to bind ReScript code to [external JS code](/docs/manual/latest/external), including binding to [global values](/docs/manual/latest/bind-to-global-js-values), [modules](/docs/manual/latest/import-from-export-to-js#import-from-javascript), [functions](/docs/manual/latest/bind-to-js-function) and [objects](/docs/manual/latest/bind-to-js-object). + + +### Example + + + +```res +@module("path") +external dirname: string => string = "dirname" + +let root = dirname("/User/github") +``` + +```js +var Path = require("path"); +var root = Path.dirname("/User/github"); +``` + + + +### References + +* [External (Bind to Any JS Library)](/docs/manual/latest/external) +* [Bind to JS Object](/docs/manual/latest/bind-to-js-object) +* [Bind to JS Function](/docs/manual/latest/bind-to-js-function) +* [Import From JavaScript](/docs/manual/latest/import-from-export-to-js#import-from-javascript) +* [Bind to Global JS Values](/docs/manual/latest/bind-to-global-js-values) \ No newline at end of file From 1ca79d6d48e1bb6f22ede1f271b71d37e3661537 Mon Sep 17 00:00:00 2001 From: Patrick Ecker Date: Tue, 9 Mar 2021 10:20:03 +0100 Subject: [PATCH 2/3] Update external binding summary --- misc_docs/syntax/language_external.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/misc_docs/syntax/language_external.mdx b/misc_docs/syntax/language_external.mdx index 2d0e8bdad..fb26ca1df 100644 --- a/misc_docs/syntax/language_external.mdx +++ b/misc_docs/syntax/language_external.mdx @@ -2,7 +2,7 @@ id: "external" keywords: ["external", "javascript"] name: "external" -summary: "This is the `external` language construct." +summary: "This is the `external binding` keyword." category: "languageconstructs" --- @@ -33,4 +33,4 @@ var root = Path.dirname("/User/github"); * [Bind to JS Object](/docs/manual/latest/bind-to-js-object) * [Bind to JS Function](/docs/manual/latest/bind-to-js-function) * [Import From JavaScript](/docs/manual/latest/import-from-export-to-js#import-from-javascript) -* [Bind to Global JS Values](/docs/manual/latest/bind-to-global-js-values) \ No newline at end of file +* [Bind to Global JS Values](/docs/manual/latest/bind-to-global-js-values) From 41c629d7cfa5c4b436944934eae0727c3c7ba634 Mon Sep 17 00:00:00 2001 From: Patrick Ecker Date: Tue, 9 Mar 2021 10:28:11 +0100 Subject: [PATCH 3/3] Update misc_docs/syntax/language_external.mdx --- misc_docs/syntax/language_external.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/misc_docs/syntax/language_external.mdx b/misc_docs/syntax/language_external.mdx index fb26ca1df..ae2ef27dd 100644 --- a/misc_docs/syntax/language_external.mdx +++ b/misc_docs/syntax/language_external.mdx @@ -6,7 +6,7 @@ summary: "This is the `external binding` keyword." category: "languageconstructs" --- -`external` is used to bind ReScript code to [external JS code](/docs/manual/latest/external), including binding to [global values](/docs/manual/latest/bind-to-global-js-values), [modules](/docs/manual/latest/import-from-export-to-js#import-from-javascript), [functions](/docs/manual/latest/bind-to-js-function) and [objects](/docs/manual/latest/bind-to-js-object). +`external` is used to bind ReScript code to [external JS code](/docs/manual/latest/external), including bindings to [global values](/docs/manual/latest/bind-to-global-js-values), [modules](/docs/manual/latest/import-from-export-to-js#import-from-javascript), [functions](/docs/manual/latest/bind-to-js-function) and [objects](/docs/manual/latest/bind-to-js-object). ### Example