PluginDefinition
PluginDefinition =
object
Defined in: packages/core/src/plugin.ts:46
Declarative configuration for creating a PlatformPlugin via PlatformPlugin.create().
Plugin authors provide this instead of manually wiring RestManager overrides.
Properties
Section titled “Properties”baseUrl
Section titled “baseUrl”baseUrl:
string
Defined in: packages/core/src/plugin.ts:51
Base URL for the platform’s API.
capabilities?
Section titled “capabilities?”
optionalcapabilities:PluginCapabilities
Defined in: packages/core/src/plugin.ts:81
Plugin capability metadata.
fetch?
Section titled “fetch?”
optionalfetch: typeofglobalThis.fetch
Defined in: packages/core/src/plugin.ts:75
Override fetch for testing.
handleRateLimit()?
Section titled “handleRateLimit()?”
optionalhandleRateLimit: (response,req,attempt) =>Promise<boolean>
Defined in: packages/core/src/plugin.ts:69
Platform-specific rate limit handling (e.g., YouTube 403 quota detection).
Parameters
Section titled “Parameters”response
Section titled “response”Response
attempt
Section titled “attempt”number
Returns
Section titled “Returns”Promise<boolean>
headers?
Section titled “headers?”
optionalheaders:Record<string,string>
Defined in: packages/core/src/plugin.ts:66
Additional default headers for all requests.
matchUrl()
Section titled “matchUrl()”matchUrl: (
url) =>ResolvedUrl|null
Defined in: packages/core/src/plugin.ts:60
URL matcher — pure function, no network calls.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”ResolvedUrl | null
name:
string
Defined in: packages/core/src/plugin.ts:48
Platform identifier (e.g., “youtube”, “twitch”).
parseRateLimitHeaders()?
Section titled “parseRateLimitHeaders()?”
optionalparseRateLimitHeaders: (headers) =>RateLimitInfo|undefined
Defined in: packages/core/src/plugin.ts:72
Parse rate limit info from response headers.
Parameters
Section titled “Parameters”headers
Section titled “headers”Headers
Returns
Section titled “Returns”RateLimitInfo | undefined
rateLimitStrategy
Section titled “rateLimitStrategy”rateLimitStrategy:
RateLimitStrategy
Defined in: packages/core/src/plugin.ts:54
Rate limiting strategy instance.
retry?
Section titled “retry?”
optionalretry:RetryConfig
Defined in: packages/core/src/plugin.ts:78
Retry configuration.
tokenManager?
Section titled “tokenManager?”
optionaltokenManager:TokenManager
Defined in: packages/core/src/plugin.ts:57
Token manager for auth (optional — some platforms use query param auth).
transformRequest()?
Section titled “transformRequest()?”
optionaltransformRequest: (req) =>RestRequest
Defined in: packages/core/src/plugin.ts:63
Transform requests before sending (e.g., inject API key, add headers).