Function run

  • run(
        config: {
            cache?: { cache_duration_minutes: number; cache_file: string };
            number: number;
            shuffle?: boolean;
            sources: {
                filter?: (...args: [string, ...unknown[]]) => boolean;
                title: string;
                url: string;
            }[];
            truncate: number;
        },
    ): Promise<any[]>

  • Parameters

    • config: {
          cache?: { cache_duration_minutes: number; cache_file: string };
          number: number;
          shuffle?: boolean;
          sources: {
              filter?: (...args: [string, ...unknown[]]) => boolean;
              title: string;
              url: string;
          }[];
          truncate: number;
      }
      • Optionalcache?: { cache_duration_minutes: number; cache_file: string }

        Configuration for the cache

        • cache_duration_minutes: number

          How long to cache a result for

        • cache_file: string

          The location of a file to use as a cache

      • number: number

        Return the n latest updates from the source list.

      • Optionalshuffle?: boolean

        Randomize the output order

      • sources: {
            filter?: (...args: [string, ...unknown[]]) => boolean;
            title: string;
            url: string;
        }[]

        A list of sources to fetch

      • truncate: number

        How many words the preview field should be truncated to in characters after HTML has been sanitized and parsed.

    Returns Promise<any[]>

Settings

Member Visibility