Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add typescript setup notice #1586

Merged
merged 3 commits into from Jan 30, 2023
Merged

docs: add typescript setup notice #1586

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d8e7aaa
docs: add typescript setup notice
KnisterPeter Jan 27, 2023
0e5f5b6
Update README.md
KnisterPeter Jan 30, 2023
966eb94
Update README.md
KnisterPeter Jan 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -172,6 +172,16 @@ import * as openpgp from './openpgp.min.mjs';

To offload cryptographic operations off the main thread, you can implement a Web Worker in your application and load OpenPGP.js from there. For an example Worker implementation, see `test/worker/worker_example.js`.

#### TypeScript

Since TS is not fully integrated in the library, TS-only dependencies are currently listed as `devDependencies`, so to compile the project you’ll need to add `@openpgp/web-stream-tools` manually:

```sh
npm install --save-dev @openpgp/web-stream-tools
```

If you notice missing or incorrect type definitions, feel free to open a PR.

### Examples

Here are some examples of how to use OpenPGP.js v5. For more elaborate examples and working code, please check out the [public API unit tests](https://github.com/openpgpjs/openpgpjs/blob/main/test/general/openpgp.js). If you're upgrading from v4 it might help to check out the [changelog](https://github.com/openpgpjs/openpgpjs/wiki/V5-Changelog) and [documentation](https://github.com/openpgpjs/openpgpjs#documentation).
Expand Down