Skip to content

Commit 4b2f352

Browse files
iamsomrajiamsomraj
committed
chore: update version to v0.1.13 in documentation
1 parent a4643e0 commit 4b2f352

File tree

12 files changed

+33
-33
lines changed

12 files changed

+33
-33
lines changed

‎docs/api/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
**vue-qs v0.1.12**
1+
**vue-qs v0.1.13**
22

33
***
44

5-
# vue-qs v0.1.12
5+
# vue-qs v0.1.13
66

77
## Namespaces
88

‎docs/api/functions/provideQueryAdapter.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.12**](../README.md)
1+
[**vue-qs v0.1.13**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **provideQueryAdapter**(`queryAdapter`): `void`
1010
11-
Defined in: [adapter-context.ts:20](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/adapter-context.ts#L20)
11+
Defined in: [adapter-context.ts:20](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/adapter-context.ts#L20)
1212

1313
Provides a query adapter to the component tree using dependency injection
1414
This makes the adapter available to all child components

‎docs/api/functions/useQueryAdapter.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.12**](../README.md)
1+
[**vue-qs v0.1.13**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **useQueryAdapter**(): `undefined` \| [`QueryAdapter`](../type-aliases/QueryAdapter.md)
1010
11-
Defined in: [adapter-context.ts:45](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/adapter-context.ts#L45)
11+
Defined in: [adapter-context.ts:45](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/adapter-context.ts#L45)
1212

1313
Retrieves the nearest provided query adapter from the component tree
1414
Returns undefined if no adapter has been provided

‎docs/api/functions/useQueryReactive.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.12**](../README.md)
1+
[**vue-qs v0.1.13**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **useQueryReactive**\<`TSchema`\>(`parameterSchema`, `options`): [`QueryReactiveReturn`](../type-aliases/QueryReactiveReturn.md)\<`TSchema`\>
1010
11-
Defined in: [composables/use-query-reactive.ts:81](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/composables/use-query-reactive.ts#L81)
11+
Defined in: [composables/use-query-reactive.ts:81](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/composables/use-query-reactive.ts#L81)
1212

1313
Manages multiple query parameters as a single reactive object with URL synchronization
1414

‎docs/api/functions/useQueryRef.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.12**](../README.md)
1+
[**vue-qs v0.1.13**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **useQueryRef**\<`T`\>(`parameterName`, `options`): [`QueryRefReturn`](../type-aliases/QueryRefReturn.md)\<`T`\>
1010
11-
Defined in: [composables/use-query-ref.ts:94](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/composables/use-query-ref.ts#L94)
11+
Defined in: [composables/use-query-ref.ts:94](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/composables/use-query-ref.ts#L94)
1212

1313
Manages a single query parameter as a Vue Ref with URL synchronization
1414

‎docs/api/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
**vue-qs v0.1.12**
1+
**vue-qs v0.1.13**
22

33
***
44

5-
# vue-qs v0.1.12
5+
# vue-qs v0.1.13
66

77
## Namespaces
88

‎docs/api/type-aliases/QueryAdapter.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.12**](../README.md)
1+
[**vue-qs v0.1.13**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **QueryAdapter** = `object`
1010
11-
Defined in: [types.ts:125](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L125)
11+
Defined in: [types.ts:125](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L125)
1212

1313
Abstraction for reading and writing query parameters
1414

@@ -18,7 +18,7 @@ Abstraction for reading and writing query parameters
1818

1919
> **getCurrentQuery**(): `Record`\<`string`, `string` \| `undefined`\>
2020
21-
Defined in: [types.ts:127](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L127)
21+
Defined in: [types.ts:127](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L127)
2222

2323
Read current query parameters as a plain object
2424

@@ -32,7 +32,7 @@ Read current query parameters as a plain object
3232

3333
> **updateQuery**(`queryUpdates`, `options?`): `void`
3434
35-
Defined in: [types.ts:129](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L129)
35+
Defined in: [types.ts:129](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L129)
3636

3737
Update query parameters in the URL
3838

@@ -58,7 +58,7 @@ Update query parameters in the URL
5858

5959
> `optional` **onQueryChange**(`callback`): () => `void`
6060
61-
Defined in: [types.ts:134](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L134)
61+
Defined in: [types.ts:134](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L134)
6262

6363
Subscribe to external query changes (returns unsubscribe function)
6464

‎docs/api/type-aliases/QueryCodec.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.12**](../README.md)
1+
[**vue-qs v0.1.13**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **QueryCodec**\<`T`\> = `object`
1010
11-
Defined in: [types.ts:23](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L23)
11+
Defined in: [types.ts:23](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L23)
1212

1313
A codec that combines both parse and serialize functions for a given type
1414

@@ -26,7 +26,7 @@ The type this codec handles
2626

2727
> **parse**: [`QueryParser`](QueryParser.md)\<`T`\>
2828
29-
Defined in: [types.ts:25](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L25)
29+
Defined in: [types.ts:25](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L25)
3030

3131
Function to parse string values from URL into typed values
3232

@@ -36,6 +36,6 @@ Function to parse string values from URL into typed values
3636

3737
> **serialize**: [`QuerySerializer`](QuerySerializer.md)\<`T`\>
3838
39-
Defined in: [types.ts:27](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L27)
39+
Defined in: [types.ts:27](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L27)
4040

4141
Function to serialize typed values back to URL strings

‎docs/api/type-aliases/RuntimeEnv.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.12**](../README.md)
1+
[**vue-qs v0.1.13**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **RuntimeEnv** = `object`
1010
11-
Defined in: [types.ts:148](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L148)
11+
Defined in: [types.ts:148](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L148)
1212

1313
Environment flags used by the default History API adapter.
1414

@@ -18,14 +18,14 @@ Environment flags used by the default History API adapter.
1818

1919
> **isClient**: `boolean`
2020
21-
Defined in: [types.ts:149](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L149)
21+
Defined in: [types.ts:149](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L149)
2222

2323
***
2424

2525
### win
2626

2727
> **win**: `Window` \| `null`
2828
29-
Defined in: [types.ts:151](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L151)
29+
Defined in: [types.ts:151](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L151)
3030

3131
Safe access to window if on client

‎docs/api/type-aliases/UseQueryReactiveOptions.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.12**](../README.md)
1+
[**vue-qs v0.1.13**](../README.md)
22

33
***
44

@@ -8,7 +8,7 @@
88

99
> **UseQueryReactiveOptions** = `object`
1010
11-
Defined in: [types.ts:113](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L113)
11+
Defined in: [types.ts:113](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L113)
1212

1313
Options for useQueryReactive composable
1414

@@ -18,7 +18,7 @@ Options for useQueryReactive composable
1818

1919
> `optional` **historyStrategy**: `"replace"` \| `"push"`
2020
21-
Defined in: [types.ts:115](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L115)
21+
Defined in: [types.ts:115](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L115)
2222

2323
History strategy when updating the URL
2424

@@ -28,7 +28,7 @@ History strategy when updating the URL
2828

2929
> `optional` **queryAdapter**: [`QueryAdapter`](QueryAdapter.md)
3030
31-
Defined in: [types.ts:117](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L117)
31+
Defined in: [types.ts:117](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L117)
3232

3333
Optional custom query adapter to use
3434

@@ -38,6 +38,6 @@ Optional custom query adapter to use
3838

3939
> `optional` **enableTwoWaySync**: `boolean`
4040
41-
Defined in: [types.ts:119](https://github.com/iamsomraj/vue-qs/blob/25821b36b15a9ec7f33138992536e546f5649808/src/types.ts#L119)
41+
Defined in: [types.ts:119](https://github.com/iamsomraj/vue-qs/blob/a4643e0077390aa3ef25224e2e3a0792449f830c/src/types.ts#L119)
4242

4343
Enable two-way synchronization with URL changes

0 commit comments

Comments
 (0)