RestManager
このコンテンツはまだ日本語訳がありません。
RestManager =
object
Defined in: packages/core/src/rest/manager.ts:24
Properties
Section titled “Properties”baseUrl
Section titled “baseUrl”
readonlybaseUrl:string
Defined in: packages/core/src/rest/manager.ts:26
createHeaders()
Section titled “createHeaders()”createHeaders: (
req) =>Promise<Record<string,string>>
Defined in: packages/core/src/rest/manager.ts:44
Build auth + custom headers for a request. Override to inject platform-specific headers.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Record<string, string>>
Precondition
Section titled “Precondition”tokenManager (if set) is ready to provide auth headers
Postcondition
Section titled “Postcondition”returns a headers record including Authorization if tokenManager is set
handleRateLimit()
Section titled “handleRateLimit()”handleRateLimit: (
response,req,attempt) =>Promise<boolean>
Defined in: packages/core/src/rest/manager.ts:70
Handle rate-limited responses (429, 403). Return true to retry. Override for platform-specific quota/rate limit detection.
Parameters
Section titled “Parameters”response
Section titled “response”Response
attempt
Section titled “attempt”number
Returns
Section titled “Returns”Promise<boolean>
Precondition
Section titled “Precondition”response has status 429 or 403
Postcondition
Section titled “Postcondition”returns true if the request should be retried, false otherwise
handleResponse()
Section titled “handleResponse()”handleResponse: <
T>(response,req) =>Promise<RestResponse<T>>
Defined in: packages/core/src/rest/manager.ts:61
Parse the response body as JSON and construct a RestResponse. Throws UnifiedLiveError if the response is not valid JSON.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”response
Section titled “response”Response
Returns
Section titled “Returns”Promise<RestResponse<T>>
Precondition
Section titled “Precondition”response.ok or a handled status code
Postcondition
Section titled “Postcondition”returns a RestResponse with parsed data and optional rate limit info
parseRateLimitHeaders()
Section titled “parseRateLimitHeaders()”parseRateLimitHeaders: (
headers) =>RateLimitInfo|undefined
Defined in: packages/core/src/rest/manager.ts:78
Extract rate limit info from response headers. Override per platform. Default returns undefined (no parsing).
Parameters
Section titled “Parameters”headers
Section titled “headers”Headers
Returns
Section titled “Returns”RateLimitInfo | undefined
Postcondition
Section titled “Postcondition”returns RateLimitInfo if headers contain rate limit data, undefined otherwise
platform
Section titled “platform”
readonlyplatform:string
Defined in: packages/core/src/rest/manager.ts:25
rateLimitStrategy
Section titled “rateLimitStrategy”
readonlyrateLimitStrategy:RateLimitStrategy
Defined in: packages/core/src/rest/manager.ts:27
request()
Section titled “request()”request: <
T>(req) =>Promise<RestResponse<T>>
Defined in: packages/core/src/rest/manager.ts:36
Execute a full request lifecycle: rate limit → headers → fetch → retry → parse.
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<RestResponse<T>>
Precondition
Section titled “Precondition”rateLimitStrategy is initialized
Postcondition
Section titled “Postcondition”returns parsed response or throws an error from the hierarchy
runRequest()
Section titled “runRequest()”runRequest: (
url,init) =>Promise<Response>
Defined in: packages/core/src/rest/manager.ts:52
Execute a single fetch call. Override to add logging, metrics, or custom transport.
Parameters
Section titled “Parameters”string
RequestInit
Returns
Section titled “Returns”Promise<Response>
Precondition
Section titled “Precondition”url is a fully-qualified URL
Postcondition
Section titled “Postcondition”returns the raw Response from the server
tokenManager
Section titled “tokenManager”
readonlytokenManager:TokenManager|undefined
Defined in: packages/core/src/rest/manager.ts:28