The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

Interface: ReadFileOrUrlOptions

utils/src.ReadFileOrUrlOptions

Hierarchy#

  • RequestInit

    ReadFileOrUrlOptions

Table of contents#

Properties#

Properties#

allowUnknownExtensions#

Optional allowUnknownExtensions: boolean

Defined in#

packages/utils/src/read-file-or-url.ts:13


body#

Optional body: BodyInit

A BodyInit object or null to set request's body.

Inherited from#

RequestInit.body

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1481


cache#

Optional cache: RequestCache

A string indicating how the request will interact with the browser's cache to set request's cache.

Inherited from#

RequestInit.cache

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1485


credentials#

Optional credentials: RequestCredentials

A string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. Sets request's credentials.

Inherited from#

RequestInit.credentials

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1489


cwd#

Optional cwd: string

Defined in#

packages/utils/src/read-file-or-url.ts:15


fallbackFormat#

Optional fallbackFormat: "json" | "yaml" | "js" | "ts"

Defined in#

packages/utils/src/read-file-or-url.ts:14


fetch#

Optional fetch: (input: RequestInfo, init?: RequestInit) => Promise<Response\>

Type declaration#

▸ (input, init?): Promise<Response\>

Parameters#
NameType
inputRequestInfo
init?RequestInit
Returns#

Promise<Response\>

Defined in#

packages/utils/src/read-file-or-url.ts:16


headers#

Optional headers: HeadersInit

A Headers object, an object literal, or an array of two-item arrays to set request's headers.

Inherited from#

RequestInit.headers

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1493


integrity#

Optional integrity: string

A cryptographic hash of the resource to be fetched by request. Sets request's integrity.

Inherited from#

RequestInit.integrity

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1497


keepalive#

Optional keepalive: boolean

A boolean to set request's keepalive.

Inherited from#

RequestInit.keepalive

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1501


method#

Optional method: string

A string to set request's method.

Inherited from#

RequestInit.method

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1505


mode#

Optional mode: RequestMode

A string to indicate whether the request will use CORS, or will be restricted to same-origin URLs. Sets request's mode.

Inherited from#

RequestInit.mode

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1509


redirect#

Optional redirect: RequestRedirect

A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.

Inherited from#

RequestInit.redirect

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1513


referrer#

Optional referrer: string

A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.

Inherited from#

RequestInit.referrer

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1517


referrerPolicy#

Optional referrerPolicy: ReferrerPolicy

A referrer policy to set request's referrerPolicy.

Inherited from#

RequestInit.referrerPolicy

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1521


signal#

Optional signal: AbortSignal

An AbortSignal to set request's signal.

Inherited from#

RequestInit.signal

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1525


window#

Optional window: any

Can only be null. Used to disassociate request from any Window.

Inherited from#

RequestInit.window

Defined in#

node_modules/typescript/lib/lib.dom.d.ts:1529