Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/dl-asset

dl-asset

npm versionnpm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Local asset download for web apps, with automatic MIME type detection.

Status

ALPHA - bleeding edge / work-in-progress

Installation

yarn add @thi.ng/dl-asset
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/dl-asset?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/dl-asset/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 426 bytes / CJS: 477 bytes / UMD: 592 bytes

Dependencies

Usage examples

Several demos in this repo's /examples directory are using this package.

A selection:

ScreenshotDescriptionLive demoSource
Various hdom-canvas shape drawing examples & SVG conversion / exportDemoSource
Parser grammar livecoding editor/playground & codegenDemoSource
Animated Voronoi diagram, cubic splines & SVG downloadDemoSource
Interactive grid generator, SVG generation & export, undo/redo supportDemoSource
1D Wolfram automata with OBJ point cloud exportDemoSource

API

Generated API docs

import { download } from "@thi.ng/dl-asset";

const src = "Hellö wörld!";

// mime type derived from file extension (.txt)
download("hello.txt", src, {
    utf8: true,
    expire: 1000
});

// with explicit MIME type string
download("hello.txt", src, {
    mime: "text/plain",
    utf8: true,
    expire: 1000
});

...or using MIME type preset from @thi.ng/mime.

import { MIME_TYPES } from "@thi.ng/mime";

download("hello.txt", src, {
    mime: MIME_TYPES.text,
    utf8: true,
    expire: 1000
});

Authors

Karsten Schmidt

License

© 2020 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc