Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RenderImageReq

Render image arguments. Render functions return Streams. Here's an example awaiting file creation,

example
async function main() {
  const imgStream = await renderScene<NodeJS.ReadableStream>(...);
  await createFile(imgStream.data, imgPath);
}

async function createFile(
  stream: NodeJS.ReadableStream,
  path: string
): Promise<void> {
  return new Promise((resolve) => {
    const ws = createWriteStream(path);
    stream.pipe(ws);
    ws.on('finish', resolve);
  });
}

Hierarchy

Index

Properties

Methods

Properties

Readonly client

client: VertexClient

An instance of VertexClient.

Readonly renderReq

renderReq: RenderReq

A {@link RenderRequest}.

Readonly verbose

verbose: boolean

Whether or not to include verbose log messages.

Methods

Optional Readonly onMsg

  • onMsg(msg: string): void