This commit is contained in:
Raven Scott
2026-02-19 17:56:13 -05:00
parent 56feb7a3fb
commit c5ed79276c
554 changed files with 2 additions and 2 deletions
+68
View File
@@ -0,0 +1,68 @@
# require-addon
Load native addons across runtimes (node and bare).
## Install
```sh
npm i require-addon
```
## Overview
`require-addon` supplies a helper for resolving native `.node` modules consistently in different runtimes. It exposes runtime-specific entrypoints via `exports`.
## API
### Usage
```js
require.addon = require('require-addon')
const binding = require.addon('.', __filename)
```
## Examples
### Load bindings
```js
require.addon = require('require-addon')
const native = require.addon('.', __filename)
```
### Use in a module
```js
const binding = require.addon('.', __filename)
module.exports = binding
```
### Runtime-specific entry
```js
const addon = require('require-addon')
```
## Best Practices
- Keep addons in predictable paths relative to the loader.
## Performance
- Addon load time depends on native module initialization.
## Security
- Only load trusted native binaries.
## Error Handling
- Handle missing addon errors for optional features.
## Integration
- Used by Bare and Node native bindings.
## License
Apache-2.0
+68
View File
@@ -0,0 +1,68 @@
# require-asset
Load assets across runtimes with a unified helper.
## Install
```sh
npm i require-asset
```
## Overview
`require-asset` provides a runtime-safe way to load non-JS assets by resolving the correct loader for Node or Bare.
## API
### Usage
```js
require.asset = require('require-asset')
const data = require.asset('./asset.txt', __filename)
```
## Examples
### Load a text asset
```js
require.asset = require('require-asset')
const text = require.asset('./message.txt', __filename)
```
### Load binary data
```js
require.asset = require('require-asset')
const bytes = require.asset('./image.png', __filename)
```
### Use in a module export
```js
module.exports = require.asset('./schema.json', __filename)
```
## Best Practices
- Keep assets alongside modules for predictable resolution.
## Performance
- Asset load time depends on file size.
## Security
- Avoid loading untrusted assets.
## Error Handling
- Handle missing asset errors at startup.
## Integration
- Useful in Bare and Node packaging flows.
## License
Apache-2.0
+68
View File
@@ -0,0 +1,68 @@
# which-runtime
Detect runtime environment and platform details.
## Install
```sh
npm i which-runtime
```
## Overview
Provides runtime and OS detection flags for Bare, Node, and browser environments.
## API
### Exports
- `runtime`, `platform`, `arch`
- `isBrowser`, `isBare`, `isNode`
- `isLinux`, `isWindows`, `isMac`, `isIOS`, `isAndroid`
## Examples
### Check runtime
```js
const rt = require('which-runtime')
if (rt.isBare) console.log('Bare runtime')
```
### Check OS
```js
if (rt.isWindows) console.log('Windows')
```
### Use in config
```js
const { platform, arch } = require('which-runtime')
console.log(platform, arch)
```
## Best Practices
- Use runtime flags to select appropriate bindings.
## Performance
- Constant-time checks.
## Security
- No special concerns.
## Error Handling
- N/A (static exports).
## Integration
- Used by Bare/Node compatibility layers.
## License
Apache-2.0