webxdc-types

Types for webxdc

When you develop a webxdc app, you use the webxdc API to communicate with other instances of the same webxdc application.

The API is available on window.webxdc.

When you develop your webxdc app in TypeScript, it's handy to have proper types for this API. This library provides those types for you.

Usage

You can install this using:

npm install -D webxdc-types

You should have a type that describes your webxdc payload structure in use by your application:

type Payload = {
  label: string;
  value: number;
};

Once you have a Payload type, you can declare the type of window.webxdc in your application:

import { WebXdc } from "webxdc-types";

declare global {
  interface Window {
    webxdc: WebXdc<Payload>;
  }
}

Now window.webxdc should be fully typed.