Skip to main content

HTMLSourceUri

export
interface HTMLSourceUri {
  body?: string;
  headers?: Record<string, string>;
  method?: string;
  uri: string;
}
Defined in packages/render-html/src/shared-types.ts

A source represented by a URI.

Fields#

body#

optional
body?: string;

The HTTP body to send with the request. This must be a valid UTF-8 string, and will be sent exactly as specified, with no additional encoding (e.g. URL-escaping or base64) applied.

headers#

optional
headers?: Record<string, string>;

Additional HTTP headers to send with the request.

method#

optional
method?: string;

The HTTP Method to use. Defaults to GET if not specified.

uri#

required
uri: string;

The URI to load in the HTML component. Can be a local or remote file.