@thi.ng/expose

@thi.ng/expose

npm versionnpm downloads Mastodon Follow

[!NOTE] This is one of 190 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

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 VITE_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 Node.js REPL:

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

Package sizes (brotli'd, pre-treeshake): ESM: 205 bytes

Dependencies

None

Usage examples

Several projects in this repo's /examples directory are using this package:

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

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 - 2024 Karsten Schmidt // Apache License 2.0

Generated using TypeDoc