Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/expose

expose

npm versionnpm downloads Twitter Follow

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

About

Conditional global variable exposition.

This package provides a single function exposeGlobal() to expose a variable in the global scope (e.g. for development/debugging purposes). It's behavior is controled by the UMBRELLA_GLOBALS or SNOWPACK_PUBLIC_UMBRELLA_GLOBALS environment variables - if either is set (to a non-empty string) the function will always be enabled. Otherwise (by default), exposeGlobal() is disabled for production builds, i.e. if process.env.NODE_ENV === "production".

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/expose

ES module import:

<script type="module" src="https://cdn.skypack.dev/@thi.ng/expose"></script>

Skypack documentation

For NodeJS (v14.6+):

node --experimental-specifier-resolution=node --experimental-repl-await

> const expose = await import("@thi.ng/expose");

Package sizes (gzipped, pre-treeshake): ESM: 243 bytes

Dependencies

None

Usage examples

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

A selection:

ScreenshotDescriptionLive demoSource
Interactive grid generator, SVG generation & export, undo/redo supportDemoSource
rstream based spreadsheet w/ S-expression formula DSLDemoSource
Minimal shader graph developed during livestream #2DemoSource
Triple store query results & sortable tableDemoSource

API

Generated API docs

Authors

Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-expose,
  title = "@thi.ng/expose",
  author = "Karsten Schmidt",
  note = "https://thi.ng/expose",
  year = 2016
}

License

© 2016 - 2021 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc