Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

createStart.ts

123 lines3.0 KB

1import { createMiddleware } from './createMiddleware'
2import type { TSS_SERVER_FUNCTION } from './constants'
3import type {
4 AnyFunctionMiddleware,
5 AnyRequestMiddleware,
6 CreateMiddlewareFn,
7} from './createMiddleware'
8import type {
9 AnySerializationAdapter,
10 Register,
11 SSROption,
12} from '@tanstack/router-core'
13​
14export interface StartInstanceOptions<
15 in out TSerializationAdapters,
16 in out TDefaultSsr,
17 in out TRequestMiddlewares,
18 in out TFunctionMiddlewares,
19> {
20 '~types': StartInstanceTypes<
21 TSerializationAdapters,
22 TDefaultSsr,
23 TRequestMiddlewares,
24 TFunctionMiddlewares
25 >
26 serializationAdapters?: TSerializationAdapters
27 defaultSsr?: TDefaultSsr
28 requestMiddleware?: TRequestMiddlewares
29 functionMiddleware?: TFunctionMiddlewares
31​
32export interface StartInstance<
33 in out TSerializationAdapters,
34 in out TDefaultSsr,
35 in out TRequestMiddlewares,
36 in out TFunctionMiddlewares,
37> {
38 getOptions: () =>
39 | Promise<
40 StartInstanceOptions<
41 TSerializationAdapters,
42 TDefaultSsr,
43 TRequestMiddlewares,
44 TFunctionMiddlewares
45 >
46 >
47 | StartInstanceOptions<
48 TSerializationAdapters,
49 TDefaultSsr,
50 TRequestMiddlewares,
51 TFunctionMiddlewares
52 >
53 createMiddleware: CreateMiddlewareFn<Register>
55​
56export interface StartInstanceTypes<
57 in out TSerializationAdapters,
58 in out TDefaultSsr,
59 in out TRequestMiddlewares,
60 in out TFunctionMiddlewares,
61> {
62 serializationAdapters: TSerializationAdapters
63 defaultSsr: TDefaultSsr
64 requestMiddleware: TRequestMiddlewares
65 functionMiddleware: TFunctionMiddlewares
67​
68export const createStart = <
69 const TSerializationAdapters extends
70 ReadonlyArray<AnySerializationAdapter> = [],
71 TDefaultSsr extends SSROption = SSROption,
72 const TRequestMiddlewares extends ReadonlyArray<AnyRequestMiddleware> = [],
73 const TFunctionMiddlewares extends ReadonlyArray<AnyFunctionMiddleware> = [],
74>(
75 getOptions: () =>
76 | Promise<
77 Omit<
78 StartInstanceOptions<
79 TSerializationAdapters,
80 TDefaultSsr,
81 TRequestMiddlewares,
82 TFunctionMiddlewares
83 >,
84 '~types'
85 >
86 >
87 | Omit<
88 StartInstanceOptions<
89 TSerializationAdapters,
90 TDefaultSsr,
91 TRequestMiddlewares,
92 TFunctionMiddlewares
93 >,
94 '~types'
95 >,
96): StartInstance<
97 TSerializationAdapters,
98 TDefaultSsr,
99 TRequestMiddlewares,
100 TFunctionMiddlewares
101> => {
102 return {
103 getOptions: async () => {
104 const options = await getOptions()
105 return options
106 },
107 createMiddleware: createMiddleware as any,
108 } as StartInstance<
109 TSerializationAdapters,
110 TDefaultSsr,
111 TRequestMiddlewares,
112 TFunctionMiddlewares
113 >
115​
116export type AnyStartInstance = StartInstance<any, any, any, any>
117export type AnyStartInstanceOptions = StartInstanceOptions<any, any, any, any>
118​
119declare module '@tanstack/router-core' {
120 interface SerializableExtensions {
121 serverFn: { [TSS_SERVER_FUNCTION]: true }
122 }