Code Monkey home page Code Monkey logo

typed-webext's Introduction

typed-webext

Type safe web extension api (partial)

Warning

Still working in progress, do not use in production

Message

Based on browser.runtime.sendMessage

To Start using this, you need to extend the MessageProtocol interface

import 'typed-webext'

declare module "typed-webext" {
  interface MessageProtocol<T = unknown> {
    "get-time": [never, number]
  }
}

sendMessage

sendMessage("get-time")
  .then((time) => {
    console.log(time)
    //          ^ time: number
  })
  .catch(error => {
    console.error(error)
  })

onMessage

// background.ts

onMessage("get-time", () => {
  const now = new Date()
  if (now.getFullYear() > 1999) {
    throw new Error("You are late!")
  } else {
    return +now
  }
})

Stream

Based on browser.runtime.connect

import 'typed-webext'

declare module "typed-webext" {
  interface StreamProtocol {
    chat: [
      // Stream sender data type
      { text: string, model: "gpt-4" },
      // Stream reciver return data type
      { text: string } | { error: ErrorObject } | { done: true }
    ]
   }
}

openStream

import { deserializeError } from 'serialize-error'

const stream = openStream("chat")

// 1. use async iterator
for await (data of stream.iter({ text: "Hi", model: "gpt-4" })) {
  if (Object.hasOwn(data, "text")) {
    console.log(data.text)
  } else if (Object.hasOwn(data, "error")) {
    console.error(deserializeError(data.error))
  }
}

// 2. use onMessage callback
stream.send({ text: "Hi", model: "gpt-4" })

stream.onMessage((data) => {
  if (Object.hasOwn(data, "text")) {
    console.log(data.text)
  } else if (Object.hasOwn(data, "error")) {
    console.error(deserializeError(data.error))
  }
})

onOpenStream

import { serializeError } from 'serialize-error'

onOpenStream("chat", (stream) => {
  stream.onMessage(data => {
    chatApi(data, { 
      signal: stream.signal,
      onStramn(data) {
        stream.send({ data })
      }
    })
      .then(() => {
        stream.send({ done: true })
        stream.close()
      })
      .catch(error => {
        if (error.name === "AbortError") {
          return
        }
        stream.send({ error: serializeError(error) })
      })
  })
})

Storage Local

Based on browser.storage.local

import 'typed-webext'

declare module "typed-webext" {
  interface StorageLocalProtocol {
    theme: "light" | "dark" | "high-contrast" | "auto"
  }
}

getStorageLocal

async function getTheme() {
  const theme = await getStorageLocal("theme", "auto")
  //    ^ "light" | "dark" | "high-contrast" | "auto"
}

setStorageLocal

async function setTheme(theme: "light" | "dark" | "high-contrast" | "auto") {
  // Key, Value
  await setStorageLocal("theme", theme)
  // Or Key-value pair
  // await setStroageLocal({ theme })
}

typed-webext's People

Contributors

ziloen avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.