Skip to main content

url

Alias path.posix to normalize URL handling on Windows.

RelativeGeneratedDocLinkOptions​

Defined in: url.ts:16

Properties​

baseURL​

baseURL: string;

Defined in: url.ts:17

currentFilePath​

currentFilePath: string;

Defined in: url.ts:18

extension?​

optional extension?: string;

Defined in: url.ts:19

knownDocPaths?​

optional knownDocPaths?: ReadonlySet<string>;

Defined in: url.ts:23

Root-level generated doc paths (without extensions), known before they are written.

linkRoot?​

optional linkRoot?: string;

Defined in: url.ts:21

Optional URL prefix (e.g. /docs) the printer puts before generated paths.

outputDir​

outputDir: string;

Defined in: url.ts:24

targetUrlPath​

targetUrlPath: string;

Defined in: url.ts:25

function toRelativeGeneratedDocLink(__namedParameters): string | undefined;

Defined in: url.ts:91

Converts a generated absolute GraphQL-Markdown doc URL into a page-relative file path. Returns undefined when the target URL does not belong to the configured baseURL.

Parameters​

__namedParameters​

RelativeGeneratedDocLinkOptions

Returns​

string | undefined