A-song-of-ice-and-fire-API - GitLite

KO | EN

gitlite — search

#css #javascript #framework #claude #open-source #cloud-native #bash #cpp #redis #database

A-song-of-ice-and-fire-API

(★ 18)

Javascript wrapper for the A song of ice and fire API

File Explorer

ZIP Download

.gitignore
asoiaf.js
LICENSE
package.json
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`Ned`

View Details ▼

Like `grep` but with powerful replace capabilities.
Unlike `sed`, as it isn't restricted to line oriented editing.

ned {{[-i|--ignore-case]}} {{[-R|--recursive]}} '{{^[dl]og}}' {{.}}

Recursively search starting in the current directory, ignoring case:

ned --colors '{{^[dl]og}}' {{.}}

Search always showing colored output:

ned --colors never '{{^[dl]og}}' {{.}}

Search never showing colored output:

🔍

`npm install`

View Details ▼

Install Node packages.

npm {{[i|install]}}

Install dependencies listed in `package.json`:

npm {{[i|install]}} {{package_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}

Download the latest version of a package and add it to the list of dev dependencies in `package.json`:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Overview ##
A-song-of-ice-and-fire-API is a Node.js wrapper for accessing [AnApiOfIceAndFire](https://github.com/joakimskoog/AnApiOfIceAndFire).

## Installation ##

The current production release of A-song-of-ice-and-fire-API is available through [npm](https://www.npmjs.com/package/asoiaf-api):

```
npm install asoiaf-api
```

## Usage ##

```javascript
> var asoaif = require('asoiaf-api');
> asoaif.getCharacterByName("Jon Snow");

[ { url: 'http://www.anapioficeandfire.com/api/characters/583',
    name: 'Jon Snow',
    gender: 'Male',
    culture: 'Northmen',
    born: 'In 283 AC',
    died: '',
    titles: [ 'Lord Commander of the Night\'s Watch' ],
    aliases: 
     [ 'Lord Snow',
       'Ned Stark\'s Bastard',
       'The Snow of Winterfell',
       'The Crow-Come-Over',
       'The 998th Lord Commander of the Night\'s Watch',
       'The Bastard of Winterfell',
       'The Black Bastard of the Wall',
       'Lord Crow' ],
    father: '',
    mother: '',
    spouse: '',
    allegiances: [ 'http://www.anapioficeandfire.com/api/houses/362' ],
    books: [ 'http://www.anapioficeandfire.com/api/books/5' ],
    povBooks: 
     [ 'http://www.anapioficeandfire.com/api/books/1',
       'http://www.anapioficeandfire.com/api/books/2',
       'http://www.anapioficeandfire.com/api/books/3',
       'http://www.anapioficeandfire.com/api/books/8' ],
    tvSeries: [ 'Season 1', 'Season 2', 'Season 3', 'Season 4', 'Season 5' ],
    playedBy: [ 'Kit Harington' ] } ]
```

## API ##

### Characters ###

**getCharacterByID**

* Accepts: A string or number representing a character ID.
* Returns: An object containing the character's properties if the character exists.

**getCharacterByName**

* Accepts: A string representing full name of the character.
* Returns: An array of objects containing all the characters with given name.

**getCharactersByCulture**

* Accepts: A string representing the culture of Character.
* Returns: An array of objects containing all the characters with given culture.

**getCharactersByGender**

* Accepts: A string representing the gender of Character.
* Returns: An array of objects containing all the characters with given gender.

**getAllCharacters**

* Returns: An array of objects containing all the characters.

### Houses ###

**getHouseByID**

* Accepts: A string or number representing a house ID.
* Returns: An object containing the house's properties if the house exists.

**getHouseByName**

* Accepts: A string representing full name of the house.
* Returns: An array of objects containing all the houses with given name.

**getHouseByRegion**

* Accepts: A string representing the region of the house.
* Returns: An array of objects containing all the houses with given region.

**getHouseByWords**

* Accepts: A string representing the words/saying of the house.
* Returns: An array of objects containing all the houses with given words/saying.

**getAllHouses**

* Returns: An array of objects containing all the houses.

### Books ###

**getBookByID**

* Accepts: A string or number representing a book ID.
* Returns: An object containing the book's properties if the book exists.

**getBookByName**

* Accepts: A string representing full name of the book.
* Returns: An array of objects containing all the books with given name.

**getAllBooks**

* Returns: An array of objects containing all the books.

### FUN ###

**getRandomCharacter**

* Returns: An object containing the properties of a random character.

**getRandomHouse**

* Returns: An object containing the properties of a random house.

**getRandomCharacterOfHouse**

* Accepts: A string representing full name of the house.
* Returns: An object containing the properties of a random character from the given house

```javascript
> var asoaif = require('asoiaf-api');
> asoaif.getRandomCharacterOfHouse("House Stark of Winterfell");

{ url: 'http://www.anapioficeandfire.com/api/characters/170',
  name: 'Barthogan Stark',
  gender: 'Male',
  culture: 'Northmen',
  born: '',
  died: '',
  titles: [ 'Lord of Winterfell', 'Warden of the North' ],
  aliases: [ 'Barth Blacksword' ],
  father: '',
  mother: '',
  spouse: '',
  allegiances: [ 'http://www.anapioficeandfire.com/api/houses/362' ],
  books: 
   [ 'http://www.anapioficeandfire.com/api/books/2',
     'http://www.anapioficeandfire.com/api/books/11' ],
  povBooks: [],
  tvSeries: [],
  playedBy: [] }

```