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

pex-io

v3.0.2

Published

File I/O in PEX.

Downloads

51

Readme

pex-io

npm version stability-stable npm minzipped size dependencies types Conventional Commits styled with prettier linted with eslint license

File I/O in PEX.

Installation

npm install pex-io

Usage

import * as io from "pex-io";

try {
  const text = await io.loadText("assets/hello.txt");
  // => DOMString
  const json = await io.loadJson("assets/color.json");
  // => Object
  const image = await io.loadImage("assets/pex.png");
  // => HTMLImageElement
  const blob = await io.loadBlob("assets/data");
  // => Blob
  const arrayBuffer = await io.loadArrayBuffer("assets/data.bin");
  // => ArrayBuffer
} catch (error) {
  console.log(error);
}

API

Modules

Typedefs

pex-io

pex-io.loadText(url, options) ⇒ Promise.<string>

Load an item and parse the Response as text.

Kind: static method of pex-io

| Param | Type | | ------- | ------------------------ | | url | RequestInfo | | options | RequestInit |

pex-io.loadJson(url, options) ⇒ Promise.<JSON>

Load an item and parse the Response as json.

Kind: static method of pex-io

| Param | Type | | ------- | ------------------------ | | url | RequestInfo | | options | RequestInit |

pex-io.loadArrayBuffer(url, options) ⇒ Promise.<ArrayBuffer>

Load an item and parse the Response as arrayBuffer.

Kind: static method of pex-io

| Param | Type | | ------- | ------------------------ | | url | RequestInfo | | options | RequestInit |

pex-io.loadBlob(url, options) ⇒ Promise.<Blob>

Load an item and parse the Response as blob.

Kind: static method of pex-io

| Param | Type | | ------- | ------------------------ | | url | RequestInfo | | options | RequestInit |

pex-io.loadImage(urlOrOpts, options) ⇒ Promise.<HTMLImageElement>

Load an item, parse the Response as blob and create a HTML Image.

Kind: static method of pex-io

| Param | Type | | --------- | ----------------------------------------------------------------- | | urlOrOpts | string | ImageOptions | | options | RequestInit |

pex-io.load(resources) ⇒ Promise.<Object.<string, LoadedResource>>

Loads resources from a named map.

Kind: static method of pex-io

| Param | Type | | --------- | -------------------------------------------- | | resources | Object.<string, Resource> |

Example

const resources = {
  hello: { text: "assets/hello.txt" },
  data: { json: "assets/data.json" },
  img: { image: "assets/tex.jpg" },
  blob: { blob: "assets/blob" },
  hdrImg: { arrayBuffer: "assets/tex.hdr", options: { mode: "no-cors" } },
};

const res = await io.load(resources);
res.hello; // => string
res.data; // => Object
res.img; // => HTMLImageElement
res.blob; // => Blob
res.hdrImg; // => ArrayBuffer

ImageOptions : object

Kind: global typedef Properties

| Name | Type | Description | | ------- | ------------------- | ----------------------------------------------------------------------------------------------------------- | | url | string | | | ...rest | * | HTMLImageElement#properties |

Resource : object

Kind: global typedef Properties

| Name | Type | Description | | --------- | ------------------------ | ------------------------------------------------------------------------------------------------- | | [text] | string | | | [json] | string | | | [image] | string | | | [binary] | string | | | [options] | RequestInit | Request#parameters |

LoadedResource : string | object | HTMLImageElement | Blob | ArrayBuffer

Kind: global typedef

License

MIT. See license file.