Zero runtime on TypeScript
npm install zero-runtimeZero runtime on TypeScript
``
$ npm install zero-runtime --save-dev
`ts
import type { FetchRule, TypedFetch, TypedJSON$stringify } from "zero-runtime";
const fetch = window.fetch as TypedFetch<
| FetchRule<{
$method: "POST";
$url: "/api/:id";
$headers: {
"Content-Type": "application/json";
};
$body: { text: string };
$response: { ok: boolean };
}>
// NOTE: You can declare search types but zero-runtime does not check it.
| FetchRule<{
$method: "GET";
$url: "/search";
$search: {q: string},
$headers: {
"Content-Type": "application/json";
};
$response: { result: string[] };
}>
>;
const stringify = JSON.stringify as TypedJSON$stringify;
const res = await fetch("/api/1", {
method: "POST",
headers: {
"Content-Type": "application/json",
},
body: stringify({ text: "text" }),
});
const ret = await res.json();
const _data1: { ok: boolean } = ret;
`
You can declare side effects of your app.
TODO: No linter for Eff yet.
`ts
import type {
Eff,
ExtractOps,
FetchRule,
TypedFetch,
TypedJSON$stringify,
DomOp,
FetchOp,
ThrowOp
} from "@mizchi/zero-rutime";
class MyError extends Error {}
type MyFetchRule = FetchRule<{
$method: "POST";
$url: "/post";
$headers: {
"Content-Type": "application/json";
};
$body: {
foo: string;
};
}>;
function doSomething(): string & Eff
if (Math.random() > 0.99999) {
throw new MyError("oops");
}
return "foo";
}
function mount(): void & Eff
// skip: type check only
if (true as any) {
return undefined as void & Eff
}
const div = document.createElement("div");
div.textContent = "hello";
document.body.append(div);
}
async function doSend(): Promise<
& void
& Eff
> {
const fetch = globalThis.fetch as TypedFetch
const stringify = JSON.stringify as TypedJSON$stringify;
try {
// skip: type check only
if (true as any) {
return undefined as void & Eff
}
const res = await fetch("/post", {
method: "POST",
body: stringify({ foo: "bar" }),
});
const _data = await res.json();
console.log(_data);
} catch (err) {
console.error(err);
}
}
function* sub() {
yield doSomething();
const ret = doSomething();
yield ret;
const _val: string = ret;
}
async function* sub2() {
yield doSomething();
yield* sub3();
yield doSend();
}
async function* sub3() {
yield doSomething();
yield doSomething();
}
async function* main() {
yield mount();
yield* sub();
yield* sub2();
}
for await (const _op of main()) {
console.log("step", _op);
}
type MainOps = ExtractOps
``
MIT