# publicsuffix-data

> Wrapper around the Public Suffix List https://publicsuffix.org/

Latest version **2.0.1** (published 2023-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install publicsuffix-data
pnpm add publicsuffix-data
yarn add publicsuffix-data
bun add publicsuffix-data
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2023-03-29 |
| First published | 2016-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 1 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | jpage |

## Links

- npm: https://www.npmjs.com/package/publicsuffix-data
- Repository: https://github.com/DullReferenceException/node-publicsuffix-data
- Homepage: https://github.com/DullReferenceException/node-publicsuffix-data#readme
- Issues: https://github.com/DullReferenceException/node-publicsuffix-data/issues
- npm.io page: https://npm.io/package/publicsuffix-data

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.9

## Recent versions

- 2.0.1 (latest) — 2023-03-29
- 2.0.0 — 2020-04-23
- 0.0.1 — 2020-04-23
- 0.0.1-security — 2016-07-22

## README

# publicsuffix-data

Module for accessing the publicsuffix.org database for TLDs

## Installing

Install using npm:

```bash
npm install --save publicsuffix-data
```

## Description

Maintains an infrequently-updated copy of the [Public Suffix List](https://publicsuffix.org/) and an API to query this
data.

Other modules for accessing static copies of the data already exist. See these modules if you do not need
an automatically-updating database:

- [publicsuffix](https://www.npmjs.com/package/publicsuffix)
- [public-suffix](https://www.npmjs.com/package/public-suffix)
- [psl](https://www.npmjs.com/package/psl)

## Usage

```javascript
const PublicSuffixData = require('publicsuffix-data');
const publicSuffixData = new PublicSuffixData({
  tts: timeToStaleInSeconds,    // Seconds until the next fetch of data will occur. Defaults to 10 days (864,000).
  ttl: timeToLiveInSeconds,     // Seconds until old data becomes invalid. Defaults to 30 days (2,592,000).
  cache: cacheFileLocation      // Defaults to ~/.publicsuffix.org
});

const result = await publicSuffixData.getTLD('foo.example.com');
console.log(result); // "com"
```

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