@mariolazzari/quotable
Advanced tools
Readme
This package is a TypeScript based wrapper around the public Quotable REST APIs
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
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
BEFORE YOU INSTALL: please read the prerequisites.
Start with cloning this repo on your local machine:
$ git clone https://github.com/mariolazzari/quotable
$ cd quotable
To install and set up the library, run:
npm install @mariolazzari/quotable
Import package
import { Quotable } from "@mariolazzari/quotable"
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.
Quotable class content handles all the requests and the responses to Quotable REST APIs.
In order to initialize Quotable client:
const quotable = new Quotable();
Quotable client includes the following methods:
Description
This asynchronous method handles GET /api/authors REST API.
Prototype
async getAuthors(params:AuthorRequest): Promise<Result<AuthorResponse>>
Sample code
const sortBy: SortBy<Author> = 'quoteCount';
const order: Order = 'desc';
const { success, data, error } = await quotable.getAuthors({
sortBy,
order,
});
Description
This asynchronous method handles GET /api/quotes/:id REST API.
Prototype
async getQuote(id:string): Promise<Result<Quote>>
Sample code
const id = '2qpi1ZKL9Ko';
const { data, error, success } = await quotable.getQuote(id);
Description
This asynchronous method handles GET /api/quotes REST API.
Prototype
async getQuotes(params:ListQuoteRequest): Promise<Result<ListQuoteResponse>>
Sample code
const tags = 'love | happiness';
const { data, error, success } = await quotable.getQuotes({ tags });
Description
This asynchronous method handles GET /api/quotes/random REST API.
Prototype
async getQuotes(params:RandomQuoteRequest): Promise<Result<Quote[]>>
Sample code
const tags = 'technology,famous-quotes';
const { success, data, error } = await quotable.getRandomQuotes({ tags });
Description
This asynchronous method handles GET /api/tags REST API.
Prototype
async getTags(params:TagRequest): Promise<Result<Tag[]>>
Sample code
const sortBy: SortBy<Tag> = 'name';
const { success, data, error } = await quotable.getTags({ sortBy });
type Author = {
// A unique id for this author
_id: string;
// A brief, one paragraph bio of the author. Source: wiki API
bio: string;
// A one-line description of the author. Typically it is the person's primary
// occupation or what they are know for.
description: string;
// The link to the author's wikipedia page or official website
link: string;
// The authors full name
name: string;
// A slug is a URL-friendly ID derived from the authors name. It can be used as
slug: string;
// The number of quotes by this author
quoteCount: string;
};
type AuthorRequest = Partial<{
slug: string;
sortBy: SortBy<Author>;
order: Order;
limit: number;
page: number;
}>;
type AuthorResponse = {
// The number of results included in this response.
count: number;
// The total number of results matching this request.
totalCount: number;
// The current page number
page: number;
// The total number of pages matching this request
totalPages: number;
// The 1-based index of the last result included in this response. This shows the
// current pagination offset.
lastItemIndex: number | null;
// The array of authors
results: Author[];
};
type ListQuoteRequest = RandomQuoteParams &
Partial<{
sortBy: Sort<Quote>;
order: Order;
page: number;
}>;
type ListQuoteResponse = {
// The number of quotes returned in this response
count: number;
// The total number of quotes matching this query
totalCount: number;
// The current page number
page: number;
// The total number of pages matching this request
totalPages: number;
// The 1-based index of the last result included in the current response.
lastItemIndex: number;
// The array of quotes
results: Quote[];
};
type Order = 'asc' | 'desc' | 'default';
type Quote = {
_id: string;
// The quotation text
content: string;
// The full name of the author
author: string;
// The `slug` of the quote author
authorSlug: string;
// The length of quote (number of characters)
length: number;
// An array of tag names for this quote
tags: string[];
};
type RandomQuoteRequest = Partial<{
limit: number;
maxLength: number;
minLength: number;
tags: string;
author: string;
}>;
type RequestParams =
| ListQuoteRequest
| RandomQuoteRequest
| AuthorRequest
| TagRequest;
type Result<T> = {
success: boolean;
data?: T;
error?: string;
};
type Sort<T> = keyof T;
type Tag = {
_id: string;
name: string;
dateAdded: string;
dateModified: string;
__v: number;
quoteCount: number;
};
type TagRequest = Partial<{
sortBy: SortBy<Tag>;
order: Order;
}>;
FAQs
Quotable REST APIs client TypeScript based
The npm package @mariolazzari/quotable receives a total of 1 weekly downloads. As such, @mariolazzari/quotable popularity was classified as not popular.
We found that @mariolazzari/quotable 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.