astoria v1.0.4

Astoria

Astoria is a Node.js 4chan board and thread monitor, useful for programatically keeping track of threads on a particular board, or posts in a particular thread, perfect for writing custom bots and scripts. Astoria makes use of, and aims to follow the guidelines of the 4chan API.

Installation :hammer:

Add Astoria to your project by installing via npm.

npm install -S astoria

Usage :coffee:

Create a new instance of Astoria:

let Astoria = require('astoria')

let astoria = new Astoria([options])

Options :wrench:

The Astoria client can be configured by passing an options object into the constructor with any of the following options.

Examples :balloon:

• Check the /tv/ board for any new threads that get posted, every 5 minutes, and log out its id.

let astoria = new Astoria({
	interval: 60 * 5, // 5 mins
	updatesOnly: true // We're only interested in threads posted from now
})

astoria.board('tv')
	.listen((context, threads, err) {
		if (err) {
			return console.log(err)
		}

		threads.forEach(thread => console.log('New thread posted: ', thread.no))
	})

• Load a /ck/ thread and stop listening once we've loaded all current replies, logging out their id.

let astoria = new Astoria()

let unsubscribe = astoria.board('ck')
	.thread('11444231')
	.listen((context, posts, err) {
		if (err) {
			return console.log(err)
		}

		posts.forEach(thread => console.log('Post: ', post.no))

		// Stop listening
		unsubscribe()
	})

API :link:

The following members exist on the Astoria client.

.options

The currently set options on the client. It is generally not recommended to overwrite these, but this property is available if needed.

.board(boardName): Astoria

Sets the board to listen to. This can be in a format such as /ck/ or ck. A board is required before the listener can begin.

Returns the current instance to allow method chaining.

Examples

astoria.board('/tv/') astoria.board('v')

.thread(threadNumber): Astoria

Sets the thread to listen to. This can either be in the format 12345678 or '12345678'. Additionally, if you wish to use an existing client which currently has a thread set, you can clear the thread by passing in null.

Returns the current instance to allow method chaining.

Examples

astoria.thread(55555555) astoria.thread('11115512')

.listen(function (context, updates, error)): function

Begin listening to the board (and thread) supplied to the client, based on the current options configuration. The listener creates a snapshot of this configuration, so if any of these values change after this method is called, it won't affect the listener.

Whenever new data is retrieved from 4chan, the callback will be invoked with the three arguments context, updates and error (described below).

Returns a function to unsubscribe from the listener. To stop listening to the board/thread, simply invoke the function.

context

context.board

The board the listener is attached to. e.g. /g/, /an/

context.thread

The thread the listener is attached to. e.g. 123512321, undefined

context.options

The options the listener is using. e.g. { interval: 30, useHttps: true, updatesOnly: true, unsubscribeOnNotFound: true }

updates

An array of new threads or posts. No matter what is being subscribed to, the following properties are available (if present) (with one exception). For example, the first post in a thread will also contain information about the thread, such as reply number, etc. (Table taken from 4chan API)

The exception being when subscribing to threads, each thread will have the following last_replies property on it.

error

If an error occurred, this will contain an error object. Errors can include 404, to notify when threads have fallen off the catalog.

Contributing :gift:

This project is open to contributions. Please raise an issue before making a contribution. Additionally, please feel free to raise an issue if you find one. For each addition, please add an appropriate test.

License :zzz:

MIT

Futher reference :book:

Please read the 4chan API documentation for further information.