@mariolazzari/philosophy-api
Advanced tools
Readme
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
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
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 handles all the requests and the responses to the Philosophy API project.
In order to initialize Philosophy client:
const client = new Philosophy()
No parameters are required by this contrsuctor.
Philosophy client includes the following public methods:
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)
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)
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)
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)
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)
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)
Description
This asynchronous method handles GET /api/ REST API.
Prototype
async getRoot(): Promise<Result<Root>>
Sample code
const root: Response<Root> = await client.getRoot()
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)
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)
In order to implement all features, the following common types have been implemended:
type Book = {
id: number;
title: string;
cover: string;
abstract: string;
country: string;
language: string;
published: string;
date: Date;
author: string;
};
type Idea = {
id: number;
author: string;
quote: string;
};
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[];
};
type Request = Partial<{
url: string;
search: string;
page: number;
}>;
type Response<T> = Partial<{
data: Result<T>;
error: string;
}>;
type Result<T> = {
count: number;
previous: string;
next: string;
results: T;
};
type Root = {
philosophers: string;
ideas: string;
books: string;
schools: string;
};
type School = {
id: number;
name: string;
philosophers: string[];
};
FAQs
Philosophy REST APIs client TypeScript based
We found that @mariolazzari/philosophy-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.