Skip to content

Interface: EnvProvider ​

Defined in: packages/minerender/src/Env.ts:22

Everything MineRender needs from the platform it is running on.

This is the seam between the browser and Node builds: core code only ever talks to the registered provider, so nothing outside of src/env/node/ may reference a Node-only module (canvas, node-persist, image-size, fs, …). Keeping that rule is what allows the browser bundle to be built without Node polyfills.

Properties ​

PropertyModifierTypeDefined in
namereadonlystringpackages/minerender/src/Env.ts:24

Methods ​

createCanvas() ​

ts
createCanvas(width, height): CompatCanvas;

Defined in: packages/minerender/src/Env.ts:26

Parameters ​

ParameterType
widthnumber
heightnumber

Returns ​

CompatCanvas


createImage() ​

ts
createImage(width?, height?): CompatImage;

Defined in: packages/minerender/src/Env.ts:28

Parameters ​

ParameterType
width?number
height?number

Returns ​

CompatImage


imageSize() ​

ts
imageSize(data): ImageSizeInfo;

Defined in: packages/minerender/src/Env.ts:31

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

Parameters ​

ParameterType
dataUint8Array

Returns ​

ImageSizeInfo


openCache() ​

ts
openCache(name, version): PersistentCache;

Defined in: packages/minerender/src/Env.ts:33

Parameters ​

ParameterType
namestring
versionnumber

Returns ​

PersistentCache