Narnia's Psychedelic Mushrooms

    res-elm

    0.1.5 • Public • Published

    This package is a fork of bs-elm-es6, which is still being actively maintained. However, this project uses the latest ReScript syntax. If you are familiar with the new syntax, you will probably be most comfortable with this project.

    res-elm

    a standalone package for interoperation between Elm and ReScript.

    Philosophy

    This is a standalone binding for Elm 0.19 ports. It has no dependencies and can be used without a bundler. It is meant to be highly idiomatic to JavaScript developers.

    Installation

    npm install res-elmin your console and then add"res-elm"` to your bs-dependencies.

    Usage

    1. (Optional) Expose the module in your Index.res, like so:
        open Elm;
    1. Define your ports type as a record, where each field is either a sendable of a type or a subscribable of a type. For example:
    type ports = 
    {
        toElm: Elm.sendable<string>,
        fromElm: Elm.subscribable<string>
    };
    1. Get your target node and initialize your app. For example:
        @bs.val bs.scope "document"
        external getElementById: string => Dom.element = "getElementById";
        let app: Elm.app<ports> = 
          Elm.Main.init({ node: getElementById("elm-target") });
    1. Use your ports. There are two ways to do this.

    The ReScript-y Way to use ports.

    res-elm exposes methods Elm.send('model, sendable<'model>) and Elm.subscribe(('model => unit), subscribable<'model>).

    You can pipe into these methods like so:

    app.ports.toElm -> Elm.send("Hello, from ReScript.");
    app.ports.fromElm -> Elm.subscribe(str => Js.log(str));

    I imagine this is the primary way most users will interact with this package.

    The JavaScript-y Way to use ports.

    res-elm also exposes a less-idiomatic-to-ReScript way to interact with Elm ports. That is, sendable<'model> and subscribable<'model> are both records with a function-valued field.

    That is, you can literally call the object method directly in ReScript like:

    app.ports.toElm.send("Hello, from ReasonML");

    This is kind of a cringe-y hack and I don't imagine it will be widely used, but it may be useful if you're coming from the JavaScript/Elm world or if you want a faster refactor from JavaScript to Reason. (Plus, I really just wanted to see if something like this would work, and it does.)

    Example

    There's a fully functioning, minimal example at https://elmandrescript.gitlab.io which includes one incoming and one outgoing port. It is explained further in the article I wrote about it.

    Let me know if you have any questions.

    For further reading

    I strongly recommend you check out my catch-all documentation on my projects. It describes how to get in touch with me if you have any questions, how to contribute code, coordinated disclosure of security vulnerabilities, and more. It will be regularly updated with any information I deem relevant to my side projects.

    Most of all, feel free to get in touch! I'm delighted to hear suggestions or field questions.

    Install

    npm i res-elm

    DownloadsWeekly Downloads

    1

    Version

    0.1.5

    License

    MIT

    Unpacked Size

    6.1 kB

    Total Files

    6

    Last publish

    Collaborators

    • webbureaucrat