@types/quotesy v1.0.3

Installation

npm install --save @types/quotesy

Summary

This package contains type definitions for quotesy (https://github.com/dwyl/quotes#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/quotesy.

index.d.ts

// Type definitions for quotesy 1.0
// Project: https://github.com/dwyl/quotes#readme
// Definitions by: Nate Silva <https://github.com/natesilva>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * Returns an Array of Quote Objects
 */
export function parse_json(): Quote[];

/**
 * Returns a random quote from the list
 */
export function random(): Quote;

/**
 * Returns a random quote for a specific tag
 * @param tag the tag to search for
 */
export function random_by_tag(tag: string): Quote;

/** A single quote from the database */
export interface Quote {
    /** The author of the quote */
    author: string;
    /** The text of the quote */
    text: string;
    /** Comma-separated list of words associated with the quote */
    tags?: string | undefined;
    /** A URL where the origin of the quote can be verified */
    source?: string | undefined;
}

Additional Details

• Last updated: Thu, 08 Jul 2021 20:20:02 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Nate Silva.