# mailchimp-subscription-library

> [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url]

Latest version **1.0.4** (published 2022-09-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install mailchimp-subscription-library
pnpm add mailchimp-subscription-library
yarn add mailchimp-subscription-library
bun add mailchimp-subscription-library
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2022-09-28 |
| First published | 2022-09-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 19.4 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | elcrostatina |
| Maintainers | elcrostatina |

## Links

- npm: https://www.npmjs.com/package/mailchimp-subscription-library
- Repository: https://github.com/elcrostatina/mailchimp-subscribe-library
- Homepage: https://github.com/elcrostatina/mailchimp-subscribe-library#readme
- Issues: https://github.com/elcrostatina/mailchimp-subscribe-library/issues
- npm.io page: https://npm.io/package/mailchimp-subscription-library

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^0.27.2

## Recent versions

- 1.0.4 (latest) — 2022-09-28
- 1.0.3 — 2022-09-28
- 1.0.2 — 2022-09-28
- 1.0.1 — 2022-09-28
- 1.0.0 — 2022-09-28

## README

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]



## Mailchimp subscription library
Allows you to subscribe users to your Mailchimp list. You can use it in your favourite framework or even in plain js/ts project.
### Installation

```sh
  npm i mailchimp-subscription-library
```

### Usage
1. Retrieve mailchimp signup form url, something like 
    ```
    https://YOUR_MAILCHIMP_FORM_HOST/subscribe?u=YOUR_U&id=YOUR_FORM_ID
    ```
2. Import the module
   ```typescript
   import { MailchimpSubscription } from 'mailchimp-subscription-library';
    ```
3. Create a new instance and call the subscribe method
   ```typescript
   const mailchimpSubscription = new MailchimpSubscription('https://YOUR_MAILCHIMP_FORM_HOST/subscribe?u=YOUR_U&id=YOUR_FORM_ID');
   const res = await mailchimpSubscription.subscribe({ FOO: 'bar' });
   
   // the response type
   { message?: string; status: SubscribeStatus }
   ```

[contributors-shield]: https://img.shields.io/github/contributors/elcrostatina/mailchimp-subscribe.svg?style=for-the-badge
[contributors-url]: https://github.com/elcrostatina/mailchimp-subscribe/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/elcrostatina/mailchimp-subscribe.svg?style=for-the-badge
[forks-url]: https://github.com/elcrostatina/mailchimp-subscribe/network/members
[stars-shield]: https://img.shields.io/github/stars/elcrostatina/mailchimp-subscribe.svg?style=for-the-badge
[stars-url]: https://github.com/elcrostatina/mailchimp-subscribe/stargazers
[issues-shield]: https://img.shields.io/github/issues/elcrostatina/mailchimp-subscribe.svg?style=for-the-badge
[issues-url]: https://github.com/elcrostatina/mailchimp-subscribe/issues

---
_Source: https://npm.io/package/mailchimp-subscription-library · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._