https://github.com/sam-parsons/deno-beep
make deno modules beep
https://github.com/sam-parsons/deno-beep
beep deno
Last synced: about 2 months ago
JSON representation
make deno modules beep
- Host: GitHub
- URL: https://github.com/sam-parsons/deno-beep
- Owner: sam-parsons
- Created: 2021-06-27T17:00:56.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-27T20:44:52.000Z (almost 4 years ago)
- Last Synced: 2025-01-21T17:34:49.523Z (3 months ago)
- Topics: beep, deno
- Language: TypeScript
- Homepage:
- Size: 4.88 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# deno-beep
> Make Deno modules beep
## Usage
```js
import beep from "https://github.com/sam-parsons/deno-beep/blob/1a6cbe610a7706e67f1fd920a1af82436fd74f9f/mod.ts"
// single beep, 500ms delay default
await beeper();
// beep 4 times w. 1000ms delay
await beeper(4, 1000);
//play a pattern of beeps
await beeper('####-#-#');
```
## API
It will not beep if the user supplies the `--no-beep` flag.
### beeper(count?)
### beeper(pattern?)
Returns a `Promise` that is resolved after beeping has ended.
#### count
Type: `number`\
Default: `1`
How many times you want it to beep.
#### pattern
Type: `string`
Construct your own pattern by supplying a string of `#` for beep `-` for pause.