Class: NodeEnv

Defined in: packages/minerender/src/env/node/NodeEnv.ts:19

EnvProvider for headless Node.

This is the only place in the library allowed to reach for Node-only modules. Nothing here may be imported from src/index.ts - it is reachable exclusively through the src/index.node.ts entry, which is what keeps canvas and friends out of the browser bundle.

canvas is an optional dependency: browser-only consumers never install its native binary. Importing this module without it will fail, which is intended - rasterisation under Node needs it.

Implements

• EnvProvider

Constructors

Constructor

new NodeEnv(): NodeEnv;

Returns

NodeEnv

Properties

Property	Modifier	Type	Default value	Defined in
name	readonly	"node"	"node"	packages/minerender/src/env/node/NodeEnv.ts:21

Methods

createCanvas()

createCanvas(width, height): CompatCanvas;

Defined in: packages/minerender/src/env/node/NodeEnv.ts:23

Parameters

Parameter	Type
width	number
height	number

Returns

CompatCanvas

Implementation of

EnvProvider.createCanvas

---

createImage()

createImage(width?, height?): CompatImage;

Defined in: packages/minerender/src/env/node/NodeEnv.ts:27

Parameters

Parameter	Type
width?	number
height?	number

Returns

CompatImage

Implementation of

EnvProvider.createImage

---

imageSize()

imageSize(data): ImageSizeInfo;

Defined in: packages/minerender/src/env/node/NodeEnv.ts:34

Read width/height out of encoded image bytes without fully decoding them.

Parameters

Parameter	Type
data	Uint8Array

Returns

ImageSizeInfo

Implementation of

EnvProvider.imageSize

---

openCache()

openCache(name, version): PersistentCache;

Defined in: packages/minerender/src/env/node/NodeEnv.ts:38

Parameters

Parameter	Type
name	string
version	number

Returns

PersistentCache

Implementation of

EnvProvider.openCache