npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mariolazzari/philosophy-api

v0.0.6

Published

Philosophy REST APIs client TypeScript based

Downloads

8

Readme

Philosophy API client


This TypeScript based package implements a REST API client to the wonderfull Philosophy API free project.

Prerequisites

This package requires NodeJS (version 18 or later) and a node package manager (Npm, Yarn, Pnpm or Bun).

To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
v10.1.0
v18.18.0

Installation

BEFORE YOU INSTALL: please read the prerequisites.

Start with cloning this repo on your local machine:

$ git clone https://github.com/mariolazzari/rijks.git
$ cd rijks

To install and set up the library, run:

npm install @mariolazzari/rijks

Usage

Import package

import { Philosophy } from "@mariolazzari/philosophy-api"

Watch mode

npm test

Unit testing

npm test

Bulding new version

npm build

This task will create a distribution version of the project inside your local dist/ folder


Philosophy class

Philosophy class handles all the requests and the responses to the Philosophy API project.

Constructor

In order to initialize Philosophy client:

const client = new Philosophy()

No parameters are required by this contrsuctor.

Methods

Philosophy client includes the following public methods:

getBooks

Description

This asynchronous method handles GET /api/books REST API.

Prototype

async getBooks(search: string, page: number): Promise<Result<Book[]>>

Sample code

const params: Request = {search: "title"}
const books: Response<Books[]> = await client.getBooks(params)

getBook

Description

This asynchronous method handles GET /api/books/:id REST API.

Prototype

async getBooks(id: number): Promise<Result<Book>>

Sample code

const id:number = 123;
const book: Response<Book> = await client.getBooks(id)

getIdeas

Description

This asynchronous method handles GET /api/ideas REST API.

Prototype

async getBooks(search: string, page: number): Promise<Result<Idea[]>>

Sample code

const params: Request = {search: "god"}
const ideas: Response<Idea[]> = await client.getBooks(params)

getIdea

Description

This asynchronous method handles GET /api/ideas/:id REST API.

Prototype

async getBooks(id: number): Promise<Result<Idea>>

Sample code

const id:number = 123;
const idea: Response<Idea> = await client.getBooks(id)

getPhilosophers

Description

This asynchronous method handles GET /api/philosophers REST API.

Prototype

async getBooks(search: string, page: number): Promise<Result<Philosopher[]>>

Sample code

const params: Request = {search: "Kant"}
const philos: Response<Philosopher[]> = await client.getPhilosophers(params)

getPhilosopher

Description

This asynchronous method handles GET /api/philosophers/:id REST API.

Prototype

async getPhilosopher(id: number): Promise<Result<Philosopher>>

Sample code

const id:number = 123;
const philo: Response<Philosopher> = await client.getPhilosopher(id)

getRoot

Description

This asynchronous method handles GET /api/ REST API.

Prototype

async getRoot(): Promise<Result<Root>>

Sample code

const root: Response<Root> = await client.getRoot()

getSchools

Description

This asynchronous method handles GET /api/schools REST API.

Prototype

async getSchools(search: string, page: number): Promise<Result<School[]>>

Sample code

const params: Request = {search: "Idealism"}
const schools: Response<School[]> = await client.getSchools(params)

getSchool

Description

This asynchronous method handles GET /api/schools/:id REST API.

Prototype

async getSchool(id: number): Promise<Result<School>>

Sample code

const id:number = 123;
const school: Response<School> = await client.getSchool(id)

Types

In order to implement all features, the following common types have been implemended:

Book

type Book = {
  id: number;
  title: string;
  cover: string;
  abstract: string;
  country: string;
  language: string;
  published: string;
  date: Date;
  author: string;
};

Idea

type Idea = {
  id: number;
  author: string;
  quote: string;
};

Philosopher

type Philosopher = {
  id: number;
  name: string;
  photo: string;
  born_date: string;
  born: Date;
  death_date: string;
  dead: Date;
  nationality: string;
  era: string;
  school: string[];
  schools: string[];
  ideas: string[];
  books: string[];
};

Request

type Request = Partial<{
  url: string;
  search: string;
  page: number;
}>;

Response

type Response<T> = Partial<{
  data: Result<T>;
  error: string;
}>;

Result

type Result<T> = {
  count: number;
  previous: string;
  next: string;
  results: T;
};

Root

type Root = {
  philosophers: string;
  ideas: string;
  books: string;
  schools: string;
};

School

type School = {
  id: number;
  name: string;
  philosophers: string[];
};

Authors

  • Mario Lazzari - Initial work

Links