https://github.com/picketapi/picket-js
Javascript library for the Picket API
https://github.com/picketapi/picket-js
Last synced: 4 months ago
JSON representation
Javascript library for the Picket API
- Host: GitHub
- URL: https://github.com/picketapi/picket-js
- Owner: picketapi
- Created: 2022-02-28T19:10:07.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-18T23:26:53.000Z (over 3 years ago)
- Last Synced: 2025-09-23T22:25:12.754Z (9 months ago)
- Language: TypeScript
- Size: 5.98 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# picket-js
## Installation
`picket-js` is an [npm package](https://www.npmjs.com/package/@picketapi/picket-js).
```shell
npm install "@picketapi/picket-js"
```
## Usage
The Picket constructor creates a new instance of the Picket class. It takes a publishable API key as a parameter.
```ts
import Picket from "@picketapi/picket-js"
const picket = new Picket("YOUR_PUBLISHABLE_KEY_HERE")
```
## Documentation
For more information, checkout the [docs](https://docs.picketapi.com/picket-docs/reference/libraries-and-sdks/javascript-library-picket-js)