😻Home

Docs for kitty.js, the JavaScript library for cats!

Welcome to kitty.js! 😻

Welcome to kitty.js! This is a library to access information about cats, their breeds, and other unique characteristics! It is written in TypeScript, hence you don't need to install those pesky type definitions ;)

kitty.js is an API wrapper of The Cat API and it gets all the data from there.

Getting started

First, install the NPM package:

npm install @kittyjs/kitty-js

Then import it into your file:

import * as kitty from "@kittyjs/kitty-js"

or you import specific functions from the library:

import { catBreeds, randomImage } from "@kittyjs/kitty-js"

After you've done this head over to the quick start page to get started!