Function getContent

  • getContent<Format, Type>(source, format, options?): Promise<Type>

  • Get the content from a source. If the source is read, it is saved to the content source, making it available for future use.

    • If the content is provided, it is returned.
    • If the source is a file path, the file is read and the content is returned.

    Type Parameters

    Parameters

    Returns Promise<Type>

    Throws

    An error if no content or source is provided.

    Example

    // Get the content from a source directly.
    const source: ContentSource<ContentFormat.Text> = {
      content: "Hello, world!",
    };

    const content = await getContent(source, ContentFormat.Text);
    console.log(content); // "Hello, world!"

    // Get the content from a file.
    const source: ContentSource<ContentFormat.Text> = {
      src: "file.txt",
    };

    const content = await getContent(source, ContentFormat.Text);
    console.log(content); // "Hello, world!"

Settings

Member Visibility