@webbtc/webln-types v3.0.0
webln-types
Type definitions for WebLN
WebLN may be implemented by a lightning browser extension (e.g. Alby) therefore WebLN can already be called directly from the browser if the user has the extension installed. This package simply adds type definitions to make it easier to integrate WebLN into web applications that are written in Typescript.
Quick Start
Install package
npm install @webbtc/webln-types --save-dev # or yarn add @webbtc/webln-types --dev
Create
webln-types.d.ts
in yoursrc
directory with the following contents to ensure the types are picked up by the Typescript compiler:
/// <reference types="@webbtc/webln-types" />
Import types from
"@webbtc/webln-types"
import type { GetInfoResponse } from "@webbtc/webln-types"; if (window.webln) { (async () => { await window.webln.enable(); const info: GetInfoResponse = await window.webln.getInfo(); console.log("Your node pubkey is", info.node.pubkey); })(); } else { console.warn("WebLN not enabled"); }
Adding WebLN to your application
Read the WebLN Guide
5 months ago
10 months ago
7 months ago
9 months ago
10 months ago
9 months ago
12 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago