Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Alwatr/notifier
Alwatr Notifier Microservice
https://github.com/Alwatr/notifier
Last synced: 30 days ago
JSON representation
Alwatr Notifier Microservice
- Host: GitHub
- URL: https://github.com/Alwatr/notifier
- Owner: Alwatr
- License: mit
- Created: 2023-09-18T14:34:48.000Z (over 1 year ago)
- Default Branch: next
- Last Pushed: 2024-10-22T22:10:04.000Z (3 months ago)
- Last Synced: 2024-10-23T15:22:46.933Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 2.68 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Alwatr Notifier
[](https://www.npmjs.com/package/@alwatr/notifier)
[](https://github.com/alwatr/notifier/issues)
[](https://github.com/alwatr/notifier/stargazers)
[](https://github.com/alwatr/notifier/blob/master/LICENSE)
A tiny and easy-to-use package for sending notifications to Alwatr Notifier service.
## Installation
```bash
npm install @alwatr/notifier
```
## Usage
```ts
import {AlwatrNotifier} from '@alwatr/notifier';
const notifier = new AlwatrNotifier({
categoryId: 'YOUR_CATEGORY_ID',
accessToken: 'YOUR_ACCESS_TOKEN',
});
notifier.notify('Hello world!');
```
## API
### `AlwatrNotifier(config)`
Creates a new `AlwatrNotifier` instance.
**Parameters:**
- `config`: `AlwatrNotifierConfig` - The configuration for the notifier.
- `apiUrl`: `string` - The API URL for the notifier service. (default: 'https//notifier.alwatr.ir')
- `accessToken`: `string` - The access token for the notifier service.
- `categoryId`: `string` - The category ID for the notification. (default: 'demo')
- `markdown`: `boolean` - Whether to send the message in markdown format. (default: false)
- `fetchOption`: `Partial` - Fetch options for the API request. (default: `{method: 'POST'}`)
**Example:**
```ts
const notifier = new AlwatrNotifier({
categoryId: 'YOUR_CATEGORY_ID',
accessToken: 'YOUR_ACCESS_TOKEN',
});
```
### `notify(message, option?)`
Sends a notification to the Alwatr Notifier service.
**Parameters:**
- `message`: `string` - The message to send.
- `option`: `NotifyOption` - Optional parameters for the notification.
- `categoryId`: `string` - The category ID for the notification.
- `markdown`: `boolean` - Whether to send the message in markdown format.
- `fetchOption`: `Partial` - Fetch options for the API request.
**Returns:**
- `Promise>` - A promise that resolves with the API response.
**Example:**
```ts
notifier.notify('Hello world!');
```
**Example with options:**
```ts
notifier.notify('## Hello world\!', {
categoryId: 'my-category',
markdown: true,
});
```
## Sponsors
The following companies, organizations, and individuals support this project ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
[](https://exirstudio.com)
### Contributing
Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request.
### License
This project is licensed under the [AGPL-3.0 License](LICENSE).