Skip to content

Add docs for NodeJS.call/1 and call!/1 #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
s3cur3 wants to merge 1 commit into
base: master
Choose a base branch
from
+27 −0
Open

Add docs for NodeJS.call/1 and call!/1 #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions lib/nodejs.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@
defmodule NodeJS do
def start_link(opts \\ []), do: NodeJS.Supervisor.start_link(opts)
def stop(), do: NodeJS.Supervisor.stop()

@doc """
Calls a Node.js function. Returns `{:ok, result}` if the call is successful, or `{:error, reason}` if the call fails.

## Options
* `:timeout` (optional): The timeout (in milliseconds) for the call. Defaults to 30 seconds.
* `:esm` (optional): Whether to use ESM modules. Defaults to false.
* `:binary` (optional): Whether to return the response in binary form. Defaults to false.

## Examples

> NodeJS.call({"markdown-renderer.js", :renderHTML}, [inputMarkdown], esm: true)
{:ok, "<html>...</html>"}
"""
def call(module, args \\ [], opts \\ []), do: NodeJS.Supervisor.call(module, args, opts)

@doc """
Calls a Node.js function. Returns the result if the call is successful, or raises `NodeJS.Error`.

## Options

See `call/3` for options.

## Example

> NodeJS.call!({"markdown-renderer.js", :renderHTML}, [inputMarkdown], esm: true)
"<html>...</html>"
"""
def call!(module, args \\ [], opts \\ []), do: NodeJS.Supervisor.call!(module, args, opts)
end