ProviderPolicy

Import from: @xbbg/xnews, @xbbg/xnews/catalog

Defined in: src/catalog.ts (declaration: catalog.d.ts:106)

Operational facts a consumer needs before pointing a scheduler at a provider. Only documented, verifiable requirements are recorded here; absence of an entry means "no special requirement is known", not "no limit exists".

Properties

maxRequestsPerSecond?

readonly optional maxRequestsPerSecond?: number

Defined in: src/catalog.ts (declaration: catalog.d.ts:108)

Documented provider-wide request rate ceiling.

---

minRequestIntervalMs?

readonly optional minRequestIntervalMs?: number

Defined in: src/catalog.ts (declaration: catalog.d.ts:110)

Documented minimum delay between consecutive requests.

---

notes?

readonly optional notes?: string

Defined in: src/catalog.ts (declaration: catalog.d.ts:119)

---

requiresApiKey?

readonly optional requiresApiKey?: boolean

Defined in: src/catalog.ts (declaration: catalog.d.ts:114)

Provider requires an API key before retrieval.

---

requiresDeclaredUserAgent?

readonly optional requiresDeclaredUserAgent?: boolean

Defined in: src/catalog.ts (declaration: catalog.d.ts:112)

Provider rejects or throttles clients without a declared User-Agent.

---

requiresTermsAcceptance?

readonly optional requiresTermsAcceptance?: string

Defined in: src/catalog.ts (declaration: catalog.d.ts:116)

URL of terms the caller must accept before the provider serves data.

---

termsUrl?

readonly optional termsUrl?: string

Defined in: src/catalog.ts (declaration: catalog.d.ts:118)

Provider terms relevant to use of the retrieved content or API.