Class Client

Constructors

  • Instantiate new Jikan client

    Parameters

    Returns Client

    Example

     const Jikan = require('jikan4.js')
    const client = new Client()

    console.log(await client.anime.get(5))

Properties

Anime resource context.

Example

const anime = await client.anime.get(5)
const episodes = await anime.getEpisodes()

console.log(anime, episodes)
characters: CharacterManager

Characters resource context.

Example

const character = await client.characters.get(1)
const voiceActors = await character.getVoiceActors()

console.log(character, voiceActors)

Clubs resource context.

Example

const club = await client.clubs.get(<id>)

console.log(club.mmeberCount)
genres: GenreManager

Genres resource context.

Example

const genres = await client.genres.list()

console.log(genres)
heartbeat: HeartBeatMonitor

Check if MAL is down.

Example

const heartbeat = await client.heartbeat.check()

if (heartbeat.down)
console.warn('MAL is down!')
magazines: MagazineManager

Magazines resource context.

Example

const magazines = await client.magazines.list()

console.log(magazines)

Manga resource context.

Example

const manga = await client.manga.get(4)
const characters = await manga.getCharacters()

console.log(manga, characters)
off: (<K>(event, listener) => undefined)

Type declaration

    • <K>(event, listener): undefined
    • Remove a listener.

      Type Parameters

      Parameters

      • event: K
      • listener: ((...args) => void | Promise<void>)
          • (...args): void | Promise<void>
          • Parameters

            Returns void | Promise<void>

      Returns undefined

      Example

      client.off('debug', console.log)
      
on: (<K>(event, listener, once?) => undefined)

Type declaration

    • <K>(event, listener, once?): undefined
    • Listen to client events.

      Type Parameters

      Parameters

      • event: K
      • listener: ((...args) => void | Promise<void>)
          • (...args): void | Promise<void>
          • Parameters

            Returns void | Promise<void>

      • Optional once: boolean

      Returns undefined

      Example

      client.on('debug', console.log)
      
once: (<K>(event, listener, once?) => undefined)

Type declaration

    • <K>(event, listener, once?): undefined
    • Listen to client events once.

      Type Parameters

      Parameters

      • event: K
      • listener: ((...args) => void | Promise<void>)
          • (...args): void | Promise<void>
          • Parameters

            Returns void | Promise<void>

      • Optional once: boolean

      Returns undefined

      Example

      client.once('debug', console.log)
      
options: ClientOptions

Current options of the client.

You can change client options anytime.

People resource context.

Example

const person = await client.people.get(<id>)
const pictures = await person.getPictures()

console.log(`${person.name}`, pictures)
producers: ProducerManager

Producers resource context.

Example

const producers = await client.producers.list()

console.log(producers)
recommendations: RecommendationManager
reviews: ReviewManager
schedules: ScheduleManager
seasons: SeasonManager

Seasons resource context.

Example

const seasons = await client.seasons.list()

console.log(seasons)

Generated using TypeDoc