cloudflare
Version:
The official TypeScript library for the Cloudflare API
372 lines • 13.2 kB
text/typescript
import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseMarkdown extends APIResource {
static readonly _key: readonly ['browserRendering', 'markdown'];
/**
* Gets markdown of a webpage from provided URL or HTML. Control page loading with
* `gotoOptions` and `waitFor*` options.
*
* @example
* ```ts
* const markdown =
* await client.browserRendering.markdown.create({
* account_id: 'account_id',
* url: 'https://www.example.com/',
* });
* ```
*/
create(params: MarkdownCreateParams, options?: RequestOptions): APIPromise<MarkdownCreateResponse>;
}
export declare class Markdown extends BaseMarkdown {
}
/**
* Markdown content. Prefixed with YAML frontmatter (e.g. `title`) when the page
* provides that metadata.
*/
export type MarkdownCreateResponse = string;
export type MarkdownCreateParams = MarkdownCreateParams.Variant0 | MarkdownCreateParams.Variant1;
export declare namespace MarkdownCreateParams {
interface Variant0 {
/**
* Path param: Account ID.
*/
account_id: string;
/**
* Body param
*/
url: string;
/**
* Query param: Cache TTL default is 5s. Set to 0 to disable.
*/
cacheTTL?: number;
/**
* Body param: The maximum duration allowed for the browser action to complete
* after the page has loaded (such as taking screenshots, extracting content, or
* generating PDFs). If this time limit is exceeded, the action stops and returns a
* timeout error.
*/
actionTimeout?: number;
/**
* Body param: Adds a script element into the page with the desired URL or content.
*/
addScriptTag?: Array<Variant0.AddScriptTag>;
/**
* Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired
* URL or a `<style type="text/css">` tag with the content.
*/
addStyleTag?: Array<Variant0.AddStyleTag>;
/**
* Body param: Only allow requests that match the provided regex patterns, eg.
* '/^.\*\.(css)'. Reject rules are applied first.
*/
allowRequestPattern?: Array<string>;
/**
* Body param: Only allow requests that match the provided resource types, eg.
* 'image' or 'script'. Reject rules are applied first.
*/
allowResourceTypes?: Array<'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other'>;
/**
* Body param: Provide credentials for HTTP authentication.
*/
authenticate?: Variant0.Authenticate;
/**
* Body param: Attempt to proceed when 'awaited' events fail or timeout.
*/
bestAttempt?: boolean;
/**
* Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
*/
cookies?: Array<Variant0.Cookie>;
/**
* Body param
*/
emulateMediaType?: string;
/**
* Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
*/
gotoOptions?: Variant0.GotoOptions;
/**
* Body param
*/
html?: string;
/**
* Body param: Block undesired requests that match the provided regex patterns, eg.
* '/^.\*\.(css)'.
*/
rejectRequestPattern?: Array<string>;
/**
* Body param: Block undesired requests that match the provided resource types, eg.
* 'image' or 'script'.
*/
rejectResourceTypes?: Array<'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other'>;
/**
* Body param
*/
setExtraHTTPHeaders?: {
[]: string;
};
/**
* Body param
*/
setJavaScriptEnabled?: boolean;
/**
* Body param
*/
userAgent?: string;
/**
* Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
*/
viewport?: Variant0.Viewport;
/**
* Body param: Wait for the selector to appear in page. Check
* [options](https://pptr.dev/api/puppeteer.page.waitforselector).
*/
waitForSelector?: Variant0.WaitForSelector;
/**
* Body param: Waits for a specified timeout before continuing.
*/
waitForTimeout?: number;
}
namespace Variant0 {
interface AddScriptTag {
id?: string;
content?: string;
type?: string;
url?: string;
}
interface AddStyleTag {
content?: string;
url?: string;
}
/**
* Provide credentials for HTTP authentication.
*/
interface Authenticate {
password: string;
username: string;
}
interface Cookie {
/**
* Cookie name.
*/
name: string;
value: string;
domain?: string;
expires?: number;
httpOnly?: boolean;
partitionKey?: string;
path?: string;
priority?: 'Low' | 'Medium' | 'High';
sameParty?: boolean;
sameSite?: 'Strict' | 'Lax' | 'None';
secure?: boolean;
sourcePort?: number;
sourceScheme?: 'Unset' | 'NonSecure' | 'Secure';
url?: string;
}
/**
* Check [options](https://pptr.dev/api/puppeteer.gotooptions).
*/
interface GotoOptions {
referer?: string;
referrerPolicy?: string;
timeout?: number;
waitUntil?: 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2' | Array<'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'>;
}
/**
* Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
*/
interface Viewport {
height: number;
width: number;
deviceScaleFactor?: number;
hasTouch?: boolean;
isLandscape?: boolean;
isMobile?: boolean;
}
/**
* Wait for the selector to appear in page. Check
* [options](https://pptr.dev/api/puppeteer.page.waitforselector).
*/
interface WaitForSelector {
selector: string;
hidden?: true;
timeout?: number;
visible?: true;
}
}
interface Variant1 {
/**
* Path param: Account ID.
*/
account_id: string;
/**
* Body param
*/
html: string;
/**
* Query param: Cache TTL default is 5s. Set to 0 to disable.
*/
cacheTTL?: number;
/**
* Body param: The maximum duration allowed for the browser action to complete
* after the page has loaded (such as taking screenshots, extracting content, or
* generating PDFs). If this time limit is exceeded, the action stops and returns a
* timeout error.
*/
actionTimeout?: number;
/**
* Body param: Adds a script element into the page with the desired URL or content.
*/
addScriptTag?: Array<Variant1.AddScriptTag>;
/**
* Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired
* URL or a `<style type="text/css">` tag with the content.
*/
addStyleTag?: Array<Variant1.AddStyleTag>;
/**
* Body param: Only allow requests that match the provided regex patterns, eg.
* '/^.\*\.(css)'. Reject rules are applied first.
*/
allowRequestPattern?: Array<string>;
/**
* Body param: Only allow requests that match the provided resource types, eg.
* 'image' or 'script'. Reject rules are applied first.
*/
allowResourceTypes?: Array<'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other'>;
/**
* Body param: Provide credentials for HTTP authentication.
*/
authenticate?: Variant1.Authenticate;
/**
* Body param: Attempt to proceed when 'awaited' events fail or timeout.
*/
bestAttempt?: boolean;
/**
* Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).
*/
cookies?: Array<Variant1.Cookie>;
/**
* Body param
*/
emulateMediaType?: string;
/**
* Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions).
*/
gotoOptions?: Variant1.GotoOptions;
/**
* Body param: Block undesired requests that match the provided regex patterns, eg.
* '/^.\*\.(css)'.
*/
rejectRequestPattern?: Array<string>;
/**
* Body param: Block undesired requests that match the provided resource types, eg.
* 'image' or 'script'.
*/
rejectResourceTypes?: Array<'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other'>;
/**
* Body param
*/
setExtraHTTPHeaders?: {
[]: string;
};
/**
* Body param
*/
setJavaScriptEnabled?: boolean;
/**
* Body param
*/
url?: string;
/**
* Body param
*/
userAgent?: string;
/**
* Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
*/
viewport?: Variant1.Viewport;
/**
* Body param: Wait for the selector to appear in page. Check
* [options](https://pptr.dev/api/puppeteer.page.waitforselector).
*/
waitForSelector?: Variant1.WaitForSelector;
/**
* Body param: Waits for a specified timeout before continuing.
*/
waitForTimeout?: number;
}
namespace Variant1 {
interface AddScriptTag {
id?: string;
content?: string;
type?: string;
url?: string;
}
interface AddStyleTag {
content?: string;
url?: string;
}
/**
* Provide credentials for HTTP authentication.
*/
interface Authenticate {
password: string;
username: string;
}
interface Cookie {
/**
* Cookie name.
*/
name: string;
value: string;
domain?: string;
expires?: number;
httpOnly?: boolean;
partitionKey?: string;
path?: string;
priority?: 'Low' | 'Medium' | 'High';
sameParty?: boolean;
sameSite?: 'Strict' | 'Lax' | 'None';
secure?: boolean;
sourcePort?: number;
sourceScheme?: 'Unset' | 'NonSecure' | 'Secure';
url?: string;
}
/**
* Check [options](https://pptr.dev/api/puppeteer.gotooptions).
*/
interface GotoOptions {
referer?: string;
referrerPolicy?: string;
timeout?: number;
waitUntil?: 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2' | Array<'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'>;
}
/**
* Check [options](https://pptr.dev/api/puppeteer.page.setviewport).
*/
interface Viewport {
height: number;
width: number;
deviceScaleFactor?: number;
hasTouch?: boolean;
isLandscape?: boolean;
isMobile?: boolean;
}
/**
* Wait for the selector to appear in page. Check
* [options](https://pptr.dev/api/puppeteer.page.waitforselector).
*/
interface WaitForSelector {
selector: string;
hidden?: true;
timeout?: number;
visible?: true;
}
}
}
export declare namespace Markdown {
export { type MarkdownCreateResponse as MarkdownCreateResponse, type MarkdownCreateParams as MarkdownCreateParams, };
}
//# sourceMappingURL=markdown.d.mts.map