Interface SatoriOgInstance

SatoriOg instance

interface SatoriOgInstance {
    generateImage: ((render: string, opts: Record<string, string>, name?: string) => Promise<string>);
}

Properties

Properties

generateImage: ((render: string, opts: Record<string, string>, name?: string) => Promise<string>)

Generate an image given a render name and options

Type declaration

    • (render, opts, name?): Promise<string>
    • Parameters

      • render: string

        Render function name

      • opts: Record<string, string>

        Render function options

      • Optionalname: string

        Image name without extenstion (optional)

      Returns Promise<string>

      Image path