# noddity-retrieval

> For remote retrieval of a simple blog index and content

Latest version **1.6.2** (published 2017-09-01) · WTFPL license · 0 weekly downloads

## Install

```sh
npm install noddity-retrieval
pnpm add noddity-retrieval
yarn add noddity-retrieval
bun add noddity-retrieval
```

## 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 | 1.6.2 |
| Published | 2017-09-01 |
| First published | 2013-11-02 |
| Weekly downloads | 0 |
| License | WTFPL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | TehShrike |
| Maintainers | tehshrike |

## Links

- npm: https://www.npmjs.com/package/noddity-retrieval
- Repository: https://github.com/TehShrike/noddity-retrieval
- Homepage: https://github.com/TehShrike/noddity-retrieval#readme
- Issues: https://github.com/TehShrike/noddity-retrieval/issues
- npm.io page: https://npm.io/package/noddity-retrieval

## Dependencies (4)

- [http-basic](https://npm.io/package/http-basic.md) ~4.0.1
- [superagent](https://npm.io/package/superagent.md) ~3.6.0
- [simple-concat](https://npm.io/package/simple-concat.md) ~1.0.0
- [text-metadata-parser](https://npm.io/package/text-metadata-parser.md) ^3.0.0

## Recent versions

- 1.6.2 (latest) — 2017-09-01
- 1.6.1 — 2017-03-08
- 1.6.0 — 2017-01-10
- 1.5.3 — 2016-06-25
- 1.5.2 — 2016-02-16
- 1.5.1 — 2015-09-22
- 1.5.0 — 2015-08-26
- 1.4.0 — 2015-08-01
- 1.3.1 — 2015-05-08
- 1.3.0 — 2015-05-07
- 1.2.0 — 2015-04-30
- 1.1.3 — 2014-10-18
- 1.1.2 — 2014-03-19
- 1.1.1 — 2014-02-10
- 1.1.0 — 2013-12-28
- … 3 more at https://npm.io/package/noddity-retrieval/versions

## README

[![Build Status](https://travis-ci.org/TehShrike/noddity-retrieval.svg)](https://travis-ci.org/TehShrike/noddity-retrieval)

Noddity Retrieval
=====

This module provides an API to a [Noddity](http://noddity.com) data store full of posts and a list of said posts.

You give it an http(s) root, and that's all it needs to provide

- an async getter function to download parsed post objects
- an async getter function to download an array of post objects based on the index.json file from the root directory


So I have this idea, right?  Where your blog posts could just be a directory with an index file and a bunch of markdown files, just being served out onto the internet.

The idea is that your root directory of posts contains:

- An index.json file, containing a JSON array of strings representing the file names that are your "official" blog posts, in order.
- Whatever markdown files you want to be accessible, with metadata stored in a format amenable to [text-metadata-parser](https://github.com/TehShrike/text-metadata-parser).

Usage
-----

```js
var retrieve = new Retrieve('http://remote-server.com/blogfiles/')

retrieve.getIndex(function(err, index) {
	if (!err && index.length > 0) {
		// Get the most recent post
		retrieve.getPost(index.pop(), function(err, post) {
			console.log("Found post named " + post.metadata.title)
			console.log("The words inside it are:\n" + post.content)
		})
	}
})

```

This is the core module of the [Noddity](http://noddity.com/) cms.

License
-----
[WTFPL](http://wtfpl2.com/)

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