stackexchange-api

stackexchange-api

A Node.js wrapper for the StackExchange API

Documentation

Disclaimer: WIP. Doesn't work with many endpoints yet.

Features:

• stackexchange-api provides a simple way to access the StackExchange API endpoints
• All complex data types from the API have a corresponding Object
• stackexchange-api is written in TypeScript and every field of every request option / result has (will eventually have) type definitions. As a result, modern editors are able to provide extensive autocompletion.

Installation

Using npm:

npm install --save stackexchange-api

Using yarn:

yarn add stackexchange-api

Usage

Including in a project:

• ES6:

import {StackExchange} from 'stackexchange-api';

• CommonJS:

const StackExchangeApi = require('stackexchange-api');

Example usage:

import {StackExchange} from 'stackexchange-api';
StackExchange.search({ // Equivalent to the /search endpoint. Go to https://paul-soporan.github.io/stackexchange-api/classes/stackexchange.html#search for details.
  inTitle: 'nodejs',
  site: 'stackoverflow'
}).then((result) => {
  console.log(result);
  // Output: Wrapper<Question>
  console.log(result.items);
  // Output: an array of Questions (Question[])
  console.log(result.items[0]);
  // Output: the first Question
  console.log(result.items[0].viewCount);
  // Output: the view count of the first Question
});

Changelog

Release Version 1.2.0 (2019-12-11)

Filters Update

Features

• Filters:
  • Filters are a new complex feature, that corresponds to Custom Filters
  • They can be used inside any request method, by providing a filter property as an option. The filter property can be a Filter object or a string (Filter.filter / 'default' / 'withbody' / 'none' / 'total')
  • More documentation and examples can be found on the wiki: Filters
  • New methods on the StackExchange class:
    • createFilter()
    • decodeFilters()
  • Made all methods on the StackExchange class filterable
• Post:
  • Added a Post class, corresponding to Type post
  • New methods on the StackExchange class:
    • getPosts()
    • getPostsByIds()

Bug Fixes

• Fixed issue badge and CircleCI status badge in README.md

Refactoring

• All class properties are now required, because they are set to null if missing
• All interface properties are now optional, because they can be filtered out from requests
• Made all properties of result-types interfaces readonly
• Enabled strict and other stricter compiler options in tsconfig.json

Dependencies

• Updated to TypeScript Version 3.7.2
• Updated Dependencies

Documentation

• Added documentation for classes