@shopify/mini-oxygen v3.0.2
Mini Oxygen
Getting Started
MiniOxygen is a local runtime that simulates Oxygen production. It is based on Cloudflare's workerd via Miniflare.
To use MiniOxygen within your app, follow these steps:
Add @shopify/mini-oxygen
as a dev dependency of your app:
npm install --save-dev @shopify/mini-oxygen
Import it and create a new instance of Mini Oxygen:
import {createMiniOxygen} from '@shopify/mini-oxygen';
const miniOxygen = createMiniOxygen({
workers: [
{
name: 'main',
modules: true,
script: `export default {
async fetch() {
const response = await fetch("https://hydrogen.shopify.dev");
return response;
}
}`,
},
],
});
Dispatch requests to MiniOxygen from the browser or any other environment:
const response = await miniOxygen.dispatchFetch('http://placeholder');
// Or with the following code via network request:
// const {workerUrl} = await miniOxygen.ready;
// const response = await fetch(workerUrl);
console.log(await response.text());
await miniOxygen.dispose();
Legacy Node.js Sandbox runtime
The previous Node.js sandbox runtime has been moved to the @shopify/mini-oxygen/node
export. It is not recommended for new projects, but can be used as follows:
import {createMiniOxygen} from '@shopify/mini-oxygen/node';
const miniOxygen = createMiniOxygen({
script: `export default {
async fetch() {
const response = await fetch("https://hydrogen.shopify.dev");
return response;
}
}`,
});
const response = await miniOxygen.dispatchFetch('http://placeholder');
console.log(await response.text());
await miniOxygen.dispose();
4 days ago
4 days ago
4 days ago
4 days ago
4 days ago
4 days ago
4 days ago
4 days ago
5 days ago
5 days ago
6 days ago
6 days ago
5 days ago
5 days ago
10 days ago
9 days ago
10 days ago
10 days ago
19 days ago
19 days ago
23 days ago
23 days ago
23 days ago
23 days ago
23 days ago
23 days ago
23 days ago
24 days ago
26 days ago
26 days ago
26 days ago
26 days ago
26 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
8 months ago
8 months ago
9 months ago
7 months ago
6 months ago
8 months ago
5 months ago
6 months ago
10 months ago
10 months ago
6 months ago
5 months ago
6 months ago
7 months ago
6 months ago
6 months ago
5 months ago
9 months ago
6 months ago
9 months ago
9 months ago
5 months ago
5 months ago
6 months ago
9 months ago
6 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
5 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago