npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@marlowe.io/runtime-rest-client

v0.4.0-beta

Published

Client of Runtime REST API

Downloads

80

Readme

Description

The runtime-rest-client package provides a JS API to interact with the runtime REST API. It is intended to work with version 0.0.5 of the API.

The main {@link index | module} exposes the {@link index.mkRestClient} function, which returns an instance of a {@link index.RestClient}.

Getting started

The @marlowe.io/runtime-rest-client package is released as an ESM module and can be used with a modern bundler or imported directly in the browser (without any bundler) as long as you use an import map.

Browser

Instantiating a client requires a runtime URL to the desired network which can either be self hosted with instructions in Marlowe starter kit or through a service such as Demeter.

The caller should run a healthcheck to ensure the runtime service is healthy throughout the lifecycle of the client.

<html>
  <body>
    <script src="https://cdn.jsdelivr.net/gh/input-output-hk/[email protected]/jsdelivr-npm-importmap.js"></script>
    <script type="module">
      import { mkRestClient } from "@marlowe.io/runtime-rest-client";

      let runtimeURL = process.env.MARLOWE_RUNTIME_URL;

      const client = mkRestClient(runtimeURL);
      const hasValidRuntime = await client.healthcheck();

      if (!hasValidRuntime) throw new Error("Invalid Marlowe Runtime instance");
    </script>
  </body>
</html>