Beignet API reference
Preparing search index...
@beignet/core
server
RouteGroupBuilder
Type Alias RouteGroupBuilder<Ctx>
RouteGroupBuilder
:
{
<
const
GroupHooks
extends
readonly
RouteHook
<
Ctx
,
object
>
[]
=
readonly
[
]
,
const
R
extends
readonly
PlainRouteDef
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
>
[]
=
readonly
PlainRouteDef
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
,
>
[]
,
>
(
group
:
{
hooks
?:
GroupHooks
;
name
:
string
;
routes
:
R
&
ValidatedRouteInputs
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
,
R
>
;
}
,
)
:
RouteGroup
<
Ctx
,
R
>
;
<
const
GroupHooks
extends
readonly
RouteHook
<
Ctx
,
object
>
[]
=
readonly
[
]
,
const
R
extends
readonly
AnyRouteDef
[]
=
readonly
AnyRouteDef
[]
,
>
(
group
:
{
hooks
?:
GroupHooks
;
name
:
string
;
routes
:
R
&
ValidatedRouteInputs
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
,
R
>
;
}
,
)
:
RouteGroup
<
Ctx
,
R
>
;
}
App-bound builder for a named route group.
Type Parameters
Ctx
Type Declaration
<
const
GroupHooks
extends
readonly
RouteHook
<
Ctx
,
object
>
[]
=
readonly
[
]
,
const
R
extends
readonly
PlainRouteDef
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
>
[]
=
readonly
PlainRouteDef
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
,
>
[]
,
>
(
group
:
{
hooks
?:
GroupHooks
;
name
:
string
;
routes
:
R
&
ValidatedRouteInputs
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
,
R
>
;
}
,
)
:
RouteGroup
<
Ctx
,
R
>
Type Parameters
const
GroupHooks
extends
readonly
RouteHook
<
Ctx
,
object
>
[]
=
readonly
[
]
const
R
extends
readonly
PlainRouteDef
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
>
[]
=
readonly
PlainRouteDef
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
>
[]
Parameters
group
:
{
hooks
?:
GroupHooks
;
name
:
string
;
routes
:
R
&
ValidatedRouteInputs
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
,
R
>
;
}
Returns
RouteGroup
<
Ctx
,
R
>
<
const
GroupHooks
extends
readonly
RouteHook
<
Ctx
,
object
>
[]
=
readonly
[
]
,
const
R
extends
readonly
AnyRouteDef
[]
=
readonly
AnyRouteDef
[]
,
>
(
group
:
{
hooks
?:
GroupHooks
;
name
:
string
;
routes
:
R
&
ValidatedRouteInputs
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
,
R
>
;
}
,
)
:
RouteGroup
<
Ctx
,
R
>
Type Parameters
const
GroupHooks
extends
readonly
RouteHook
<
Ctx
,
object
>
[]
=
readonly
[
]
const
R
extends
readonly
AnyRouteDef
[]
=
readonly
AnyRouteDef
[]
Parameters
group
:
{
hooks
?:
GroupHooks
;
name
:
string
;
routes
:
R
&
ValidatedRouteInputs
<
Ctx
&
AddedCtxFromHooks
<
GroupHooks
>
,
R
>
;
}
Returns
RouteGroup
<
Ctx
,
R
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Beignet API reference
Loading...
App-bound builder for a named route group.