# francisparker-api

> Francis Parker Public api. To work with data at https://francisparkerlouisville.org or other fp services

Latest version **0.2.0** (published 2022-09-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install francisparker-api
pnpm add francisparker-api
yarn add francisparker-api
bun add francisparker-api
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2022-09-19 |
| First published | 2022-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 8.6 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | RIGIK93 |
| Maintainers | rigik93 |

## Links

- npm: https://www.npmjs.com/package/francisparker-api
- Repository: https://github.com/francisparker/francisparker-api
- Homepage: https://github.com/francisparker/francisparker-api#readme
- Issues: https://github.com/francisparker/francisparker-api/issues
- npm.io page: https://npm.io/package/francisparker-api

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [moment](https://npm.io/package/moment.md) ^2.29.4
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.12
- [typescript](https://npm.io/package/typescript.md) ^4.8.3
- [@types/node](https://npm.io/package/@types/node.md) ^18.7.18

## Recent versions

- 0.2.0 (latest) — 2022-09-19
- 0.1.0 — 2022-09-16
- 0.0.1 — 2022-09-15

## README

# Francis Parker Public API
Hello, this is Francis Parker Public API. It's used to access data on [francis parker website](https://francisparkerlouisville.org) and other related to francis parker resources
# installation
```
$ npm install francisparker-api
```
# API's
## News API
News API is used to fetch news from [Wyvern Bulletin Board](https://francisparkerlouisville.org/wyvernbullbtinboard/)
### Fetch The Latest Article
You can get the latest published article
```typescript
// Import function that fetches news
import { fetchLatest } from 'francisparker-api/news'
// Import Interface for typing (optional)
import type { Article } from 'francisparker-api/news'

// fetch article
async function main() {
    const article: Article = await fetchLatest()
}

main() 
```

### Fetch The Whole Page
You can get a list of articles at a certain page
```typescript
// Import function that fetches news
import { fetchPage } from 'francisparker-api/news'
// Import Interface for typing (optional)
import type { Article } from 'francisparker-api/news'

// fetch articles
async function main() {
    const pageNumber: number = 0 // page numbers are integers [0, last page], where 0 is the first page (page with the latest news)
    const articles: Article[] = await fetchPage(pageNumber)
}

main() 
```

### Fetch A Specific Article
You can fetch a specific article by number. Starting from 0 (the newest article) to max (the oldest article)
```typescript
// Import function that fetches news
import { fetchArticle } from 'francisparker-api/news'
// Import Interface for typing (optional)
import type { Article } from 'francisparker-api/news'

// fetch article
async function main() {
    const articleNumber: number = 0 // article numbers are integers [0, last article], where 0 is the latest article and last article is the oldest one
    const article: Article = await fetchArticle(articleNumber)
}

main()
```

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