Ant Design X

type XRequestFunction<Input = Record<PropertyKey, any>, Output = Record<string, string>> = (
  baseURL: string,
  options: XRequestOptions<Input, Output>,
) => XRequestClass<Input, Output>;

XRequestFunction

Property	Description	Type	Default	Version
baseURL	API endpoint URL	string	-	-
options	Request options	XRequestOptions<Input, Output>	-	-

XRequestOptions

Property	Description	Type	Default	Version
callbacks	Request callback handlers	XRequestCallbacks<Output>	-	-
params	Request parameters	Input	-	-
headers	Additional request headers	Record<string, string>	-	-
timeout	Request timeout configuration (time from sending request to connecting to service), unit: ms	number	-	-
streamTimeout	Stream mode data timeout configuration (time interval for each chunk return), unit: ms	number	-	-
fetch	Custom fetch object	`typeof fetch`	-	-
middlewares	Middlewares for pre- and post-request processing	XFetchMiddlewares	-	-
transformStream	Stream processor	XStreamOptions<Output>['transformStream'] \| ((baseURL: string, responseHeaders: Headers) => XStreamOptions<Output>['transformStream'])	-	-
streamSeparator	Stream separator, used to separate different data streams	string	\n\n	2.2.0
partSeparator	Part separator, used to separate different parts of data	string	\n	2.2.0
kvSeparator	Key-value separator, used to separate keys and values	string	:	2.2.0
manual	Whether to manually control request sending. When `true`, need to manually call `run` method	boolean	false	-
retryInterval	Retry interval when request is interrupted or fails, in milliseconds. If not set, automatic retry will not occur	number	-	-
retryTimes	Maximum number of retry attempts. No further retries will be attempted after exceeding this limit	number	-	-

XRequestCallbacks

Property	Description	Type	Default	Version
onSuccess	Success callback	(chunks: Output[]) => void	-	-
onError	Error handling callback. `onError` can return a number indicating the retry interval (in milliseconds) when a request exception occurs. When both `onError` return value and `options.retryInterval` exist, the `onError` return value takes precedence	(error: Error, errorInfo: any) => number \| void	-	-
onUpdate	Message update callback	(chunk: Output) => void	-	-

XRequestClass

Property	Description	Type	Default	Version
abort	Cancel request	() => void	-	-
run	Manually execute request (effective when `manual=true`)	(params?: Input) => void	-	-
isRequesting	Whether currently requesting	boolean	-	-

setXRequestGlobalOptions

ts

type setXRequestGlobalOptions<Input, Output> = (
  options: XRequestGlobalOptions<Input, Output>,
) => void;

XRequestGlobalOptions

ts

type XRequestGlobalOptions<Input, Output> = Pick<
  XRequestOptions<Input, Output>,
  'headers' | 'timeout' | 'streamTimeout' | 'middlewares' | 'fetch' | 'transformStream' | 'manual'
>;

XFetchMiddlewares

ts

interface XFetchMiddlewares {
  onRequest?: (...ags: Parameters<typeof fetch>) => Promise<Parameters<typeof fetch>>;
  onResponse?: (response: Response) => Promise<Response>;
}

When To Use

Make requests to backend service APIs to get response data. For OpenAI Compatible LLM services, it's recommended to use XModelAPI.

Code Demo

API

XRequestFunction

ts

type XRequestFunction<Input = Record<PropertyKey, any>, Output = Record<string, string>> = (
  baseURL: string,
  options: XRequestOptions<Input, Output>,
) => XRequestClass<Input, Output>;

XRequestFunction

Property	Description	Type	Default	Version
baseURL	API endpoint URL	string	-	-
options	Request options	XRequestOptions<Input, Output>	-	-

XRequestOptions

Property	Description	Type	Default	Version
callbacks	Request callback handlers	XRequestCallbacks<Output>	-	-
params	Request parameters	Input	-	-
headers	Additional request headers	Record<string, string>	-	-
timeout	Request timeout configuration (time from sending request to connecting to service), unit: ms	number	-	-
streamTimeout	Stream mode data timeout configuration (time interval for each chunk return), unit: ms	number	-	-
fetch	Custom fetch object	`typeof fetch`	-	-
middlewares	Middlewares for pre- and post-request processing	XFetchMiddlewares	-	-
transformStream	Stream processor	XStreamOptions<Output>['transformStream'] \| ((baseURL: string, responseHeaders: Headers) => XStreamOptions<Output>['transformStream'])	-	-
streamSeparator	Stream separator, used to separate different data streams	string	\n\n	2.2.0
partSeparator	Part separator, used to separate different parts of data	string	\n	2.2.0
kvSeparator	Key-value separator, used to separate keys and values	string	:	2.2.0
manual	Whether to manually control request sending. When `true`, need to manually call `run` method	boolean	false	-
retryInterval	Retry interval when request is interrupted or fails, in milliseconds. If not set, automatic retry will not occur	number	-	-
retryTimes	Maximum number of retry attempts. No further retries will be attempted after exceeding this limit	number	-	-

XRequestCallbacks

Property	Description	Type	Default	Version
onSuccess	Success callback	(chunks: Output[]) => void	-	-
onError	Error handling callback. `onError` can return a number indicating the retry interval (in milliseconds) when a request exception occurs. When both `onError` return value and `options.retryInterval` exist, the `onError` return value takes precedence	(error: Error, errorInfo: any) => number \| void	-	-
onUpdate	Message update callback	(chunk: Output) => void	-	-

XRequestClass

Property	Description	Type	Default	Version
abort	Cancel request	() => void	-	-
run	Manually execute request (effective when `manual=true`)	(params?: Input) => void	-	-
isRequesting	Whether currently requesting	boolean	-	-

setXRequestGlobalOptions

ts

type setXRequestGlobalOptions<Input, Output> = (
  options: XRequestGlobalOptions<Input, Output>,
) => void;

XRequestGlobalOptions

ts

type XRequestGlobalOptions<Input, Output> = Pick<
  XRequestOptions<Input, Output>,
  'headers' | 'timeout' | 'streamTimeout' | 'middlewares' | 'fetch' | 'transformStream' | 'manual'
>;

XFetchMiddlewares

ts

interface XFetchMiddlewares {
  onRequest?: (...ags: Parameters<typeof fetch>) => Promise<Parameters<typeof fetch>>;
  onResponse?: (response: Response) => Promise<Response>;
}