Skip to content

Commit a9248df

Browse files
committed
docs: update experimental status
1 parent 328c68d commit a9248df

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

src/core/extendRoutes.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ export class EditableTreeNode {
3434
* Inserts a new route as a child of this route. This route cannot use `definePage()`. If it was meant to be included,
3535
* add it to the `routesFolder` option.
3636
*
37-
* @param path - path segment to insert. Note this is relative to the current route. It shouldn't start with `/` unless you want the route path to be absolute.
38-
* added at the root of the tree.
37+
* @param path - path segment to insert. Note this is relative to the current route. **It shouldn't start with `/`**. If it does, it will be added to the root of the tree.
3938
* @param filePath - file path
39+
* @returns the new editable route node
4040
*/
4141
insert(path: string, filePath: string) {
4242
// adapt paths as they should match a file system

src/options.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,17 +149,13 @@ export interface Options {
149149
* Allows to extend a route by modifying its node, adding children, or even deleting it. This will be invoked once for
150150
* each route.
151151
*
152-
* @experimental See https://github.com/posva/unplugin-vue-router/issues/43
153-
*
154152
* @param route - {@link EditableTreeNode} of the route to extend
155153
*/
156154
extendRoute?: (route: EditableTreeNode) => _Awaitable<void>
157155

158156
/**
159157
* Allows to do some changes before writing the files. This will be invoked **every time** the files need to be written.
160158
*
161-
* @experimental See https://github.com/posva/unplugin-vue-router/issues/43
162-
*
163159
* @param rootRoute - {@link EditableTreeNode} of the root route
164160
*/
165161
beforeWriteFiles?: (rootRoute: EditableTreeNode) => _Awaitable<void>

0 commit comments

Comments
 (0)