Skip to content

Commit 6c39e69

Browse files
committed
docs: fix links
1 parent 5e893b3 commit 6c39e69

30 files changed

+393
-996
lines changed

netlify.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
NPM_FLAGS="--version"
33

44
[build]
5-
command = "npx pnpm@6 i --store=node_modules/.pnpm-store && npx pnpm@6 run docs:build"
5+
command = "npx pnpm@7 i --store=node_modules/.pnpm-store && npx pnpm@6 run docs:build"
66
ignore = "./scripts/docs-check.sh"
77
publish = "packages/docs/.vitepress/dist"

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
"jest": "^28.1.3",
4040
"jest-environment-jsdom": "^28.1.3",
4141
"jest-mock-warn": "^1.1.0",
42-
"lint-staged": "^12.5.0",
42+
"lint-staged": "^13.0.3",
4343
"lodash.kebabcase": "^4.1.1",
4444
"minimist": "^1.2.6",
4545
"p-series": "^3.0.0",
@@ -52,7 +52,7 @@
5252
"semver": "^7.3.7",
5353
"typedoc": "^0.23.9",
5454
"typedoc-plugin-markdown": "^3.13.4",
55-
"typescript": "^4.6.3",
55+
"typescript": "^4.7.4",
5656
"vue": "^3.2.37",
5757
"yorkie": "^2.0.0"
5858
},

packages/docs/api/enums/pinia.MutationType.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,6 @@ Direct mutation of the state:
2424
- `store.$state.name = 'new name'`
2525
- `store.list.push('new item')`
2626

27-
#### Defined in
28-
29-
[packages/pinia/src/types.ts:50](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L50)
30-
3127
___
3228

3329
### patchFunction
@@ -38,10 +34,6 @@ Mutated the state with `$patch` and a function
3834

3935
- `store.$patch(state => state.name = 'newName')`
4036

41-
#### Defined in
42-
43-
[packages/pinia/src/types.ts:64](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L64)
44-
4537
___
4638

4739
### patchObject
@@ -51,7 +43,3 @@ ___
5143
Mutated the state with `$patch` and an object
5244

5345
- `store.$patch({ name: 'newName' })`
54-
55-
#### Defined in
56-
57-
[packages/pinia/src/types.ts:57](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L57)

packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,3 @@ augment stores with the plugin API.
4141
Extracted actions. Added by useStore(). SHOULD NOT be added by the user when
4242
creating the store. Can be used in plugins to get the list of actions in a
4343
store defined with a setup function. Note this is always defined
44-
45-
#### Defined in
46-
47-
[packages/pinia/src/types.ts:697](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L697)

packages/docs/api/interfaces/pinia.DefineStoreOptions.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@ augment stores with the plugin API.
4040

4141
Optional object of actions.
4242

43-
#### Defined in
44-
45-
[packages/pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L645)
46-
4743
___
4844

4945
### getters
@@ -52,10 +48,6 @@ ___
5248

5349
Optional object of getters.
5450

55-
#### Defined in
56-
57-
[packages/pinia/src/types.ts:638](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L638)
58-
5951
___
6052

6153
### id
@@ -64,10 +56,6 @@ ___
6456

6557
Unique string key to identify the store across the application.
6658

67-
#### Defined in
68-
69-
[packages/pinia/src/types.ts:627](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L627)
70-
7159
___
7260

7361
### state
@@ -85,10 +73,6 @@ correct typings!
8573

8674
`S`
8775

88-
#### Defined in
89-
90-
[packages/pinia/src/types.ts:633](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L633)
91-
9276
## Methods
9377

9478
### hydrate
@@ -126,7 +110,3 @@ const useStore = defineStore('main', {
126110
#### Returns
127111

128112
`void`
129-
130-
#### Defined in
131-
132-
[packages/pinia/src/types.ts:678](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L678)

packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,6 @@ Extracted object of actions. Added by useStore() when the store is built
3737
using the setup API, otherwise uses the one passed to `defineStore()`.
3838
Defaults to an empty object if no actions are defined.
3939

40-
#### Defined in
41-
42-
[packages/pinia/src/types.ts:714](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L714)
43-
4440
___
4541

4642
### getters
@@ -53,10 +49,6 @@ Optional object of getters.
5349

5450
Omit.getters
5551

56-
#### Defined in
57-
58-
[packages/pinia/src/types.ts:638](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L638)
59-
6052
___
6153

6254
### state
@@ -78,10 +70,6 @@ correct typings!
7870

7971
Omit.state
8072

81-
#### Defined in
82-
83-
[packages/pinia/src/types.ts:633](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L633)
84-
8573
## Methods
8674

8775
### hydrate
@@ -123,7 +111,3 @@ const useStore = defineStore('main', {
123111
#### Inherited from
124112

125113
Omit.hydrate
126-
127-
#### Defined in
128-
129-
[packages/pinia/src/types.ts:678](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/types.ts#L678)

packages/docs/api/interfaces/pinia.Pinia.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,6 @@ Every application must own its own pinia to be able to create stores
3838

3939
`void`
4040

41-
#### Defined in
42-
43-
[packages/pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/rootStore.ts#L46)
44-
4541
___
4642

4743
### state
@@ -50,10 +46,6 @@ ___
5046

5147
root state
5248

53-
#### Defined in
54-
55-
[packages/pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/rootStore.ts#L51)
56-
5749
## Methods
5850

5951
### use
@@ -71,7 +63,3 @@ Adds a store plugin to extend every store
7163
#### Returns
7264

7365
[`Pinia`](pinia.Pinia.md)
74-
75-
#### Defined in
76-
77-
[packages/pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/rootStore.ts#L58)

packages/docs/api/interfaces/pinia.PiniaCustomProperties.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,6 @@ Interface to be extended by the user when they add properties through plugins.
3131

3232
`RouteLocationNormalized`
3333

34-
#### Defined in
35-
36-
[packages/playground/src/main.ts:17](https://github.com/vuejs/pinia/blob/aa0192a/packages/playground/src/main.ts#L17)
37-
3834
`set` **route**(`value`): `void`
3935

4036
#### Parameters
@@ -46,7 +42,3 @@ Interface to be extended by the user when they add properties through plugins.
4642
#### Returns
4743

4844
`void`
49-
50-
#### Defined in
51-
52-
[packages/playground/src/main.ts:14](https://github.com/vuejs/pinia/blob/aa0192a/packages/playground/src/main.ts#L14)

packages/docs/api/interfaces/pinia.PiniaPlugin.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,3 @@ nothing.
2828
#### Returns
2929

3030
`void` \| `Partial`<[`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\> & [`PiniaCustomStateProperties`](pinia.PiniaCustomStateProperties.md)<[`StateTree`](../modules/pinia.md#statetree)\>\>
31-
32-
#### Defined in
33-
34-
[packages/pinia/src/rootStore.ts:140](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/rootStore.ts#L140)

packages/docs/api/interfaces/pinia.PiniaPluginContext.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ Context argument passed to Pinia plugins.
2929

3030
Current app created with `Vue.createApp()`.
3131

32-
#### Defined in
33-
34-
[packages/pinia/src/rootStore.ts:117](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/rootStore.ts#L117)
35-
3632
___
3733

3834
### options
@@ -41,10 +37,6 @@ ___
4137

4238
Initial options defining the store when calling `defineStore()`.
4339

44-
#### Defined in
45-
46-
[packages/pinia/src/rootStore.ts:127](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/rootStore.ts#L127)
47-
4840
___
4941

5042
### pinia
@@ -53,18 +45,10 @@ ___
5345

5446
pinia instance.
5547

56-
#### Defined in
57-
58-
[packages/pinia/src/rootStore.ts:112](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/rootStore.ts#L112)
59-
6048
___
6149

6250
### store
6351

6452
**store**: [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>
6553

6654
Current store being extended.
67-
68-
#### Defined in
69-
70-
[packages/pinia/src/rootStore.ts:122](https://github.com/vuejs/pinia/blob/aa0192a/packages/pinia/src/rootStore.ts#L122)

0 commit comments

Comments
 (0)