mygo-runtime
v0.10.0
Published
Typed access to the MyGo runtime in the pages of MyGo desktop apps
Readme
mygo-runtime
Typed access to the runtime of MyGo apps, for their web frontends.
MyGo injects its runtime into every page of an app as window.mygo. This
package gives it types and imports. The client that mygo generate writes
for your bound Go services is built on it, so you mostly use that:
import { Greeter, events } from "./mygo"; // generated
const greeting = await Greeter.greet("Ada");
events.tick.on((time) => console.log(time));Use the package directly for the window and the platform:
import { currentWindow, isCallError, isMyGo, runtime } from "mygo-runtime";
if (isMyGo() && runtime().platform === "darwin") {
document.body.classList.add("mac");
}
await currentWindow.toggleMaximize();A Go method that streams values through a *mygo.Channel[T] parameter takes
a Channel in its place:
import { Channel } from "mygo-runtime";
const lines = new Channel<string>();
const done = Shell.tail("ls -R", lines);
for await (const line of lines) console.log(line);
await done;A Go method returning an error rejects with a CallError (see
isCallError). Outside a MyGo window, e.g. when the dev server is opened in a
browser, calls reject and isMyGo() is false.
mygo-runtime/i18n formats the messages of the app's catalogs in its pages,
as package i18n does in Go: messages of ICU MessageFormat, with the plural
rules, numbers and dates of Intl. mygo generate writes a typed module of
the catalogs next to the client (locales.ts) on top of it:
import { messages } from "./locales"; // generated
status.textContent = messages.filesSelected(3); // "3 files selected"formatMessage(locale, message, args) formats a message of your own.
