aboutsummaryrefslogtreecommitdiff
path: root/src/content/chapter5_advanced_features/lesson04_externals
diff options
context:
space:
mode:
authorLouis Pilfold <louis@lpil.uk>2024-01-18 17:47:12 +0000
committerLouis Pilfold <louis@lpil.uk>2024-01-18 17:47:12 +0000
commit3bfbe688f5a62e29835c7d3c4f282e7fff57949d (patch)
tree038cd1bf7a72949f7d68358ffd8af59d073ef70a /src/content/chapter5_advanced_features/lesson04_externals
parentf92661980deac22b54e79cd44c25caba17910c95 (diff)
downloadtour-3bfbe688f5a62e29835c7d3c4f282e7fff57949d.tar.gz
tour-3bfbe688f5a62e29835c7d3c4f282e7fff57949d.zip
Rename
Diffstat (limited to 'src/content/chapter5_advanced_features/lesson04_externals')
-rw-r--r--src/content/chapter5_advanced_features/lesson04_externals/code.gleam17
-rw-r--r--src/content/chapter5_advanced_features/lesson04_externals/text.html25
2 files changed, 42 insertions, 0 deletions
diff --git a/src/content/chapter5_advanced_features/lesson04_externals/code.gleam b/src/content/chapter5_advanced_features/lesson04_externals/code.gleam
new file mode 100644
index 0000000..ade2c54
--- /dev/null
+++ b/src/content/chapter5_advanced_features/lesson04_externals/code.gleam
@@ -0,0 +1,17 @@
+import gleam/io
+
+// A type with no Gleam constructors
+pub type DateTime
+
+// An external function that creates an instance of the type
+@external(javascript, "./my_package_ffi.mjs", "now")
+pub fn now() -> DateTime
+
+// The `now` function in `./my_package_ffi.mjs` looks like this:
+// external function now() {
+// return new Date();
+// }
+
+pub fn main() {
+ io.debug(now())
+}
diff --git a/src/content/chapter5_advanced_features/lesson04_externals/text.html b/src/content/chapter5_advanced_features/lesson04_externals/text.html
new file mode 100644
index 0000000..81202d6
--- /dev/null
+++ b/src/content/chapter5_advanced_features/lesson04_externals/text.html
@@ -0,0 +1,25 @@
+<p>
+ Sometimes in our projects we want to use code written in other languages, most
+ commonly Erlang and JavaScript, depending on which runtime is being used.
+ Gleam's <em>external functions</em> and <em>external types</em> allow us to
+ import and use this non-Gleam code.
+</p>
+<p>
+ An external type is a one that has no constructors. Gleam doesn't know what
+ shape it has or how to create one, it only knows that it exists.
+</p>
+<p>
+ An external function is one that has the <code>@external</code> attribute on
+ it, directing the compiler to use the specified module function as the
+ implementation, instead of Gleam code.
+</p>
+<p>
+ The compiler can't tell the types of functions written in other languages, so
+ when the external attribute is given type annotations must be provided. Gleam
+ trusts that the type given is correct so an inaccurate type annotation can
+ result in unexpected behaviour and crashes at runtime. Be careful!
+</p>
+<p>
+ External functions are useful but should be used sparingly. Prefer to write
+ Gleam code where possible.
+</p>