pex-io


File I/O in PEX.

Installation

``bash
npm install pex-io
`

Usage

`js
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
const bytes = await io.loadBytes("assets/data.bin");
// => Uint8Array
} catch (error) {
console.log(error);
}
`

API

Modules

pex-io

Typedefs

ImageOptions : object

VideoOptions : object

Resource : object

LoadedResource : string | object | HTMLImageElement | Blob | ArrayBuffer

pex-io

- pex-io
- [.loadText(url, [fetchOptions])](#module_pex-io.loadText) ⇒ Promise.<string>
- [.loadJson(url, [fetchOptions])](#module_pex-io.loadJson) ⇒ Promise.<JSON>
- [.loadArrayBuffer(url, [fetchOptions])](#module_pex-io.loadArrayBuffer) ⇒ Promise.<ArrayBuffer>
- [.loadBytes(url, [fetchOptions])](#module_pex-io.loadBytes) ⇒ Promise.<Uint8Array>
- [.loadBlob(url, [fetchOptions])](#module_pex-io.loadBlob) ⇒ Promise.<Blob>
- [.loadImage(urlOrImageProperties, [fetchOptions])](#module_pex-io.loadImage) ⇒ Promise.<HTMLImageElement>
- [.loadVideo(urlOrVideoProperties, [fetchOptions])](#module_pex-io.loadVideo) ⇒ Promise.<HTMLVideoElement>
- .load(resources) ⇒ Promise.<Object.<string, LoadedResource>>

$3

Load an item and parse the Response as text.

Kind: static method of pex-io

| Param | Type |
| -------------- | ------------------------ |
| url | RequestInfo |
| [fetchOptions] | RequestInit |

$3

Load an item and parse the Response as json.

Kind: static method of pex-io

| Param | Type |
| -------------- | ------------------------ |
| url | RequestInfo |
| [fetchOptions] | RequestInit |

$3

Load an item and parse the Response as arrayBuffer.

Kind: static method of pex-io

| Param | Type |
| -------------- | ------------------------ |
| url | RequestInfo |
| [fetchOptions] | RequestInit |

$3

Load an item and parse the Response as bytes.

Kind: static method of pex-io

| Param | Type |
| -------------- | ------------------------ |
| url | RequestInfo |
| [fetchOptions] | RequestInit |

$3

Load an item and parse the Response as blob.

Kind: static method of pex-io

| Param | Type |
| -------------- | ------------------------ |
| url | RequestInfo |
| [fetchOptions] | RequestInit |

$3

Create and load a HTML Image. If fetchOptions are specified, load and parse the Response as blob to set the "src" property.

Kind: static method of pex-io

| Param | Type |
| -------------------- | ----------------------------------------------------------------- |
| urlOrImageProperties | string \| ImageOptions |
| [fetchOptions] | RequestInit |

$3

Create and load a HTML Video. If fetchOptions are specified, load and parse the Response as blob to set the "src" property.

Kind: static method of pex-io

| Param | Type |
| -------------------- | ----------------------------------------------------------------- |
| urlOrVideoProperties | string \| VideoOptions |
| [fetchOptions] | RequestInit |

$3

Loads resources from a named map.

Kind: static method of pex-io

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

Example

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

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

ImageOptions : object

Kind: global typedef
Properties

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

VideoOptions : object

Kind: global typedef
Properties

| Name | Type | Description |
| ------- | ------------------- | --------------------------------------------------------------------------------------------------------- |
| url | string | |
| ...rest | \* | HTMLVideoElement#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.