Understand the project
Practical overview
When it fits
Use js-waku when building a TypeScript application that needs to communicate over Waku, or when consulting the project's API documentation.
Who it is for
- TypeScript developers building applications that communicate over Waku.
- Developers creating decentralized communication clients for browser or server environments.
Documented uses
- Add Waku messaging capabilities to a TypeScript application.
- Build a decentralized communication client using Waku.
- Consult or generate the library's API documentation.
Before you choose
Requirements & limits
- The project is a protocol implementation for developers, not a finished messaging application.
- The repository documents local API-documentation generation using Git and npm.
- The repository states that the project is available under either MIT or Apache License 2.0, at the user's option.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Source-based practical guide
Generate js-waku API documentation locally
Create the project API documentation from a local repository checkout.
Before you start
- Git
- Node.js package manager npm
Steps
Clone the js-waku repository.
Change into the repository directory.
Run npm install.
Run npm run doc.
Expected outcome
The repository's API documentation is generated locally.
Guide limitations
- These steps generate API documentation only; they do not set up or run a Waku messaging application.
Evidence and transparency
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 13 October 2026
- Original website title
- logos-messaging/logos-delivery-js · Official homepage title · retained in its source language