Blame view

天文台pc/tianwentai-ui/node_modules/react-router/dist/development/browser-CJ9_du-U.d.ts 12.6 KB
bc518174   王天杨   提交两个项目文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
  import * as React from 'react';
  import { L as Location, C as ClientActionFunction, a as ClientLoaderFunction, b as LinksFunction, M as MetaFunction, S as ShouldRevalidateFunction, P as Params, c as RouterContextProvider, A as ActionFunction, H as HeadersFunction, d as LoaderFunction, e as RouterInit } from './instrumentation-DvHY1sgY.js';
  
  type RSCRouteConfigEntryBase = {
      action?: ActionFunction;
      clientAction?: ClientActionFunction;
      clientLoader?: ClientLoaderFunction;
      ErrorBoundary?: React.ComponentType<any>;
      handle?: any;
      headers?: HeadersFunction;
      HydrateFallback?: React.ComponentType<any>;
      Layout?: React.ComponentType<any>;
      links?: LinksFunction;
      loader?: LoaderFunction;
      meta?: MetaFunction;
      shouldRevalidate?: ShouldRevalidateFunction;
  };
  type RSCRouteConfigEntry = RSCRouteConfigEntryBase & {
      id: string;
      path?: string;
      Component?: React.ComponentType<any>;
      lazy?: () => Promise<RSCRouteConfigEntryBase & ({
          default?: React.ComponentType<any>;
          Component?: never;
      } | {
          default?: never;
          Component?: React.ComponentType<any>;
      })>;
  } & ({
      index: true;
  } | {
      children?: RSCRouteConfigEntry[];
  });
  type RSCRouteConfig = Array<RSCRouteConfigEntry>;
  type RSCRouteManifest = {
      clientAction?: ClientActionFunction;
      clientLoader?: ClientLoaderFunction;
      element?: React.ReactElement | false;
      errorElement?: React.ReactElement;
      handle?: any;
      hasAction: boolean;
      hasComponent: boolean;
      hasErrorBoundary: boolean;
      hasLoader: boolean;
      hydrateFallbackElement?: React.ReactElement;
      id: string;
      index?: boolean;
      links?: LinksFunction;
      meta?: MetaFunction;
      parentId?: string;
      path?: string;
      shouldRevalidate?: ShouldRevalidateFunction;
  };
  type RSCRouteMatch = RSCRouteManifest & {
      params: Params;
      pathname: string;
      pathnameBase: string;
  };
  type RSCRenderPayload = {
      type: "render";
      actionData: Record<string, any> | null;
      basename: string | undefined;
      errors: Record<string, any> | null;
      loaderData: Record<string, any>;
      location: Location;
      matches: RSCRouteMatch[];
      patches?: RSCRouteManifest[];
      nonce?: string;
      formState?: unknown;
  };
  type RSCManifestPayload = {
      type: "manifest";
      patches: RSCRouteManifest[];
  };
  type RSCActionPayload = {
      type: "action";
      actionResult: Promise<unknown>;
      rerender?: Promise<RSCRenderPayload | RSCRedirectPayload>;
  };
  type RSCRedirectPayload = {
      type: "redirect";
      status: number;
      location: string;
      replace: boolean;
      reload: boolean;
      actionResult?: Promise<unknown>;
  };
  type RSCPayload = RSCRenderPayload | RSCManifestPayload | RSCActionPayload | RSCRedirectPayload;
  type RSCMatch = {
      statusCode: number;
      headers: Headers;
      payload: RSCPayload;
  };
  type DecodeActionFunction = (formData: FormData) => Promise<() => Promise<unknown>>;
  type DecodeFormStateFunction = (result: unknown, formData: FormData) => unknown;
  type DecodeReplyFunction = (reply: FormData | string, options: {
      temporaryReferences: unknown;
  }) => Promise<unknown[]>;
  type LoadServerActionFunction = (id: string) => Promise<Function>;
  /**
   * Matches the given routes to a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
   * and returns an [RSC](https://react.dev/reference/rsc/server-components)
   * [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
   * encoding an {@link unstable_RSCPayload} for consumption by an [RSC](https://react.dev/reference/rsc/server-components)
   * enabled client router.
   *
   * @example
   * import {
   *   createTemporaryReferenceSet,
   *   decodeAction,
   *   decodeReply,
   *   loadServerAction,
   *   renderToReadableStream,
   * } from "@vitejs/plugin-rsc/rsc";
   * import { unstable_matchRSCServerRequest as matchRSCServerRequest } from "react-router";
   *
   * matchRSCServerRequest({
   *   createTemporaryReferenceSet,
   *   decodeAction,
   *   decodeFormState,
   *   decodeReply,
   *   loadServerAction,
   *   request,
   *   routes: routes(),
   *   generateResponse(match) {
   *     return new Response(
   *       renderToReadableStream(match.payload),
   *       {
   *         status: match.statusCode,
   *         headers: match.headers,
   *       }
   *     );
   *   },
   * });
   *
   * @name unstable_matchRSCServerRequest
   * @public
   * @category RSC
   * @mode data
   * @param opts Options
   * @param opts.allowedActionOrigins Origin patterns that are allowed to execute actions.
   * @param opts.basename The basename to use when matching the request.
   * @param opts.createTemporaryReferenceSet A function that returns a temporary
   * reference set for the request, used to track temporary references in the [RSC](https://react.dev/reference/rsc/server-components)
   * stream.
   * @param opts.decodeAction Your `react-server-dom-xyz/server`'s `decodeAction`
   * function, responsible for loading a server action.
   * @param opts.decodeFormState A function responsible for decoding form state for
   * progressively enhanceable forms with React's [`useActionState`](https://react.dev/reference/react/useActionState)
   * using your `react-server-dom-xyz/server`'s `decodeFormState`.
   * @param opts.decodeReply Your `react-server-dom-xyz/server`'s `decodeReply`
   * function, used to decode the server function's arguments and bind them to the
   * implementation for invocation by the router.
   * @param opts.generateResponse A function responsible for using your
   * `renderToReadableStream` to generate a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
   * encoding the {@link unstable_RSCPayload}.
   * @param opts.loadServerAction Your `react-server-dom-xyz/server`'s
   * `loadServerAction` function, used to load a server action by ID.
   * @param opts.onError An optional error handler that will be called with any
   * errors that occur during the request processing.
   * @param opts.request The [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request)
   * to match against.
   * @param opts.requestContext An instance of {@link RouterContextProvider}
   * that should be created per request, to be passed to [`action`](../../start/data/route-object#action)s,
   * [`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
   * @param opts.routes Your {@link unstable_RSCRouteConfigEntry | route definitions}.
   * @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
   * that contains the [RSC](https://react.dev/reference/rsc/server-components)
   * data for hydration.
   */
  declare function matchRSCServerRequest({ allowedActionOrigins, createTemporaryReferenceSet, basename, decodeReply, requestContext, loadServerAction, decodeAction, decodeFormState, onError, request, routes, generateResponse, }: {
      allowedActionOrigins?: string[];
      createTemporaryReferenceSet: () => unknown;
      basename?: string;
      decodeReply?: DecodeReplyFunction;
      decodeAction?: DecodeActionFunction;
      decodeFormState?: DecodeFormStateFunction;
      requestContext?: RouterContextProvider;
      loadServerAction?: LoadServerActionFunction;
      onError?: (error: unknown) => void;
      request: Request;
      routes: RSCRouteConfigEntry[];
      generateResponse: (match: RSCMatch, { onError, temporaryReferences, }: {
          onError(error: unknown): string | undefined;
          temporaryReferences: unknown;
      }) => Response;
  }): Promise<Response>;
  
  type BrowserCreateFromReadableStreamFunction = (body: ReadableStream<Uint8Array>, { temporaryReferences, }: {
      temporaryReferences: unknown;
  }) => Promise<unknown>;
  type EncodeReplyFunction = (args: unknown[], options: {
      temporaryReferences: unknown;
  }) => Promise<BodyInit>;
  /**
   * Create a React `callServer` implementation for React Router.
   *
   * @example
   * import {
   *   createFromReadableStream,
   *   createTemporaryReferenceSet,
   *   encodeReply,
   *   setServerCallback,
   * } from "@vitejs/plugin-rsc/browser";
   * import { unstable_createCallServer as createCallServer } from "react-router";
   *
   * setServerCallback(
   *   createCallServer({
   *     createFromReadableStream,
   *     createTemporaryReferenceSet,
   *     encodeReply,
   *   })
   * );
   *
   * @name unstable_createCallServer
   * @public
   * @category RSC
   * @mode data
   * @param opts Options
   * @param opts.createFromReadableStream Your `react-server-dom-xyz/client`'s
   * `createFromReadableStream`. Used to decode payloads from the server.
   * @param opts.createTemporaryReferenceSet A function that creates a temporary
   * reference set for the [RSC](https://react.dev/reference/rsc/server-components)
   * payload.
   * @param opts.encodeReply Your `react-server-dom-xyz/client`'s `encodeReply`.
   * Used when sending payloads to the server.
   * @param opts.fetch Optional [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
   * implementation. Defaults to global [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch).
   * @returns A function that can be used to call server actions.
   */
  declare function createCallServer({ createFromReadableStream, createTemporaryReferenceSet, encodeReply, fetch: fetchImplementation, }: {
      createFromReadableStream: BrowserCreateFromReadableStreamFunction;
      createTemporaryReferenceSet: () => unknown;
      encodeReply: EncodeReplyFunction;
      fetch?: (request: Request) => Promise<Response>;
  }): (id: string, args: unknown[]) => Promise<unknown>;
  /**
   * Props for the {@link unstable_RSCHydratedRouter} component.
   *
   * @name unstable_RSCHydratedRouterProps
   * @category Types
   */
  interface RSCHydratedRouterProps {
      /**
       * Your `react-server-dom-xyz/client`'s `createFromReadableStream` function,
       * used to decode payloads from the server.
       */
      createFromReadableStream: BrowserCreateFromReadableStreamFunction;
      /**
       * Optional fetch implementation. Defaults to global [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/fetch).
       */
      fetch?: (request: Request) => Promise<Response>;
      /**
       * The decoded {@link unstable_RSCPayload} to hydrate.
       */
      payload: RSCPayload;
      /**
       * `"eager"` or `"lazy"` - Determines if links are eagerly discovered, or
       * delayed until clicked.
       */
      routeDiscovery?: "eager" | "lazy";
      /**
       * A function that returns an {@link RouterContextProvider} instance
       * which is provided as the `context` argument to client [`action`](../../start/data/route-object#action)s,
       * [`loader`](../../start/data/route-object#loader)s and [middleware](../../how-to/middleware).
       * This function is called to generate a fresh `context` instance on each
       * navigation or fetcher call.
       */
      getContext?: RouterInit["getContext"];
  }
  /**
   * Hydrates a server rendered {@link unstable_RSCPayload} in the browser.
   *
   * @example
   * import { startTransition, StrictMode } from "react";
   * import { hydrateRoot } from "react-dom/client";
   * import {
   *   unstable_getRSCStream as getRSCStream,
   *   unstable_RSCHydratedRouter as RSCHydratedRouter,
   * } from "react-router";
   * import type { unstable_RSCPayload as RSCPayload } from "react-router";
   *
   * createFromReadableStream(getRSCStream()).then((payload) =>
   *   startTransition(async () => {
   *     hydrateRoot(
   *       document,
   *       <StrictMode>
   *         <RSCHydratedRouter
   *           createFromReadableStream={createFromReadableStream}
   *           payload={payload}
   *         />
   *       </StrictMode>,
   *       { formState: await getFormState(payload) },
   *     );
   *   }),
   * );
   *
   * @name unstable_RSCHydratedRouter
   * @public
   * @category RSC
   * @mode data
   * @param props Props
   * @param {unstable_RSCHydratedRouterProps.createFromReadableStream} props.createFromReadableStream n/a
   * @param {unstable_RSCHydratedRouterProps.fetch} props.fetch n/a
   * @param {unstable_RSCHydratedRouterProps.getContext} props.getContext n/a
   * @param {unstable_RSCHydratedRouterProps.payload} props.payload n/a
   * @param {unstable_RSCHydratedRouterProps.routeDiscovery} props.routeDiscovery n/a
   * @returns A hydrated {@link DataRouter} that can be used to navigate and
   * render routes.
   */
  declare function RSCHydratedRouter({ createFromReadableStream, fetch: fetchImplementation, payload, routeDiscovery, getContext, }: RSCHydratedRouterProps): React.JSX.Element;
  
  export { type BrowserCreateFromReadableStreamFunction as B, type DecodeActionFunction as D, type EncodeReplyFunction as E, type LoadServerActionFunction as L, RSCHydratedRouter as R, type DecodeFormStateFunction as a, type DecodeReplyFunction as b, createCallServer as c, type RSCManifestPayload as d, type RSCPayload as e, type RSCRenderPayload as f, type RSCHydratedRouterProps as g, type RSCMatch as h, type RSCRouteManifest as i, type RSCRouteMatch as j, type RSCRouteConfigEntry as k, type RSCRouteConfig as l, matchRSCServerRequest as m };