@@ -6,6 +6,14 @@ import type {
66} from './gen/index.js' ;
77import { of } from './gen/rxjsStub.js' ;
88
9+ /**
10+ * Per-call options accepted as the optional second argument by generated API methods.
11+ *
12+ * Use {@link setHeaderOptions} and {@link setRequestTimeoutOptions} for common options, or add
13+ * middleware such as {@link requestTimeoutMiddleware} directly for custom composition.
14+ */
15+ export type ApiRequestOptions = ConfigurationOptions < ObservableMiddleware > ;
16+
917export function setHeaderMiddleware ( key : string , value : string ) : ObservableMiddleware {
1018 return {
1119 pre : ( request : RequestContext ) => {
@@ -38,10 +46,7 @@ export function requestTimeoutMiddleware(milliseconds: number): ObservableMiddle
3846}
3947
4048/** Returns call options that abort a request after the given number of milliseconds. */
41- export function setRequestTimeoutOptions (
42- milliseconds : number ,
43- opt ?: ConfigurationOptions < ObservableMiddleware > ,
44- ) : ConfigurationOptions < ObservableMiddleware > {
49+ export function setRequestTimeoutOptions ( milliseconds : number , opt ?: ApiRequestOptions ) : ApiRequestOptions {
4550 const existingMiddleware = opt ?. middleware || [ ] ;
4651 return {
4752 ...opt ,
@@ -51,11 +56,7 @@ export function setRequestTimeoutOptions(
5156}
5257
5358// Returns ConfigurationOptions that set a header
54- export function setHeaderOptions (
55- key : string ,
56- value : string ,
57- opt ?: ConfigurationOptions < ObservableMiddleware > ,
58- ) : ConfigurationOptions < ObservableMiddleware > {
59+ export function setHeaderOptions ( key : string , value : string , opt ?: ApiRequestOptions ) : ApiRequestOptions {
5960 const newMiddlware = setHeaderMiddleware ( key , value ) ;
6061 const existingMiddlware = opt ?. middleware || [ ] ;
6162 return {
0 commit comments