ForgeRequestOptions

Defined in: packages/core/src/adapters/ForgeAdapter.ts:44

Low-level options passed to ForgeAdapter.fetch. Generated client functions construct this automatically — you rarely need to interact with ForgeRequestOptions directly.

Properties

authContext

authContext: AuthContext

Defined in: packages/core/src/adapters/ForgeAdapter.ts:56

Who is making the request

---

body?

optional body?: unknown

Defined in: packages/core/src/adapters/ForgeAdapter.ts:52

Request body — will be JSON-serialised

---

headers?

optional headers?: Record<string, string>

Defined in: packages/core/src/adapters/ForgeAdapter.ts:54

Additional HTTP headers to include

---

method

method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"

Defined in: packages/core/src/adapters/ForgeAdapter.ts:46

HTTP method for the request

---

path

path: string

Defined in: packages/core/src/adapters/ForgeAdapter.ts:48

Relative API path, e.g. /rest/api/3/issue/PROJ-123

---

queryParams?

optional queryParams?: Record<string, unknown>

Defined in: packages/core/src/adapters/ForgeAdapter.ts:50

Query string parameters — undefined values are omitted

---

signal?

optional signal?: AbortSignal

Defined in: packages/core/src/adapters/ForgeAdapter.ts:58

Optional AbortSignal for cancellation