newgrounds-api/dist/classes/Newgrounds.d.ts

A simple Node.js library for interacting with the Newgrounds data.

import { SearchOptions, AudioSearchResult } from "../interfaces/search.js";
import { Audio } from "./Audio.js";
import { BaseOptions } from "../interfaces/baseOptions.js";
import puppeteer from "puppeteer";
import { Playlist } from "./Playlist.js";
/**
 * Represents the Newgrounds API
 * @class Newgrounds
 */
export declare class Newgrounds {
    readonly options: BaseOptions;
    readonly puppeteer: typeof puppeteer;
    constructor();
    /**
     * Search for audio on Newgrounds
     * @param {string} terms The search terms
     * @param {SearchOptions} options The search options
     * @returns {Promise<AudioSearchResult[]>}
     */
    searchAudio(terms: string, options?: SearchOptions): Promise<AudioSearchResult[]>;
    /**
     * Get details of an audio.
     * @param {string} id audio id
     * @returns {Promise<Audio>}
     */
    getAudio(id: string): Promise<Audio>;
    /**
     * Get details of a playlist.
     * @param {string} id playlist id
     * @returns {Promise<Playlist>}
     */
    getPlaylist(id: string): Promise<Playlist>;
}