Skip to content

Commit 03a7742

Browse files
iamsomrajiamsomraj
committed
chore: update documentation for vue-qs v0.1.17
- Bump version to v0.1.17 in all relevant files. - Update links to source code in documentation to reflect the new commit hash. - Minor formatting adjustments in documentation for consistency.
1 parent b89690c commit 03a7742

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+177
-181
lines changed

‎docs/api/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
**vue-qs v0.1.16**
1+
**vue-qs v0.1.17**
22

3-
---
3+
***
44

5-
# vue-qs v0.1.16
5+
# vue-qs v0.1.17
66

77
## Namespaces
88

‎docs/api/functions/areValuesEqual.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / areValuesEqual
66

77
# Function: areValuesEqual()
88

99
> **areValuesEqual**\<`T`\>(`valueA`, `valueB`, `customEquals?`): `boolean`
1010
11-
Defined in: [utils/core-helpers.ts:82](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/utils/core-helpers.ts#L82)
11+
Defined in: [utils/core-helpers.ts:82](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/utils/core-helpers.ts#L82)
1212

1313
Safely compares two values for equality
1414

‎docs/api/functions/buildSearchString.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / buildSearchString
66

77
# Function: buildSearchString()
88

99
> **buildSearchString**(`queryObject`): `string`
1010
11-
Defined in: [utils/core-helpers.ts:57](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/utils/core-helpers.ts#L57)
11+
Defined in: [utils/core-helpers.ts:57](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/utils/core-helpers.ts#L57)
1212

1313
Safely converts a query object to a URL search string
1414

‎docs/api/functions/createArrayCodec.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / createArrayCodec
66

77
# Function: createArrayCodec()
88

99
> **createArrayCodec**\<`T`\>(`elementCodec`, `delimiter`): [`QueryCodec`](../type-aliases/QueryCodec.md)\<`T`[]\>
1010
11-
Defined in: [serializers.ts:148](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/serializers.ts#L148)
11+
Defined in: [serializers.ts:148](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/serializers.ts#L148)
1212

1313
Array codec factory for handling arrays with a specific element type
1414

‎docs/api/functions/createEnumCodec.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / createEnumCodec
66

77
# Function: createEnumCodec()
88

99
> **createEnumCodec**\<`T`\>(`allowedValues`): [`QueryCodec`](../type-aliases/QueryCodec.md)\<`T`\>
1010
11-
Defined in: [serializers.ts:190](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/serializers.ts#L190)
11+
Defined in: [serializers.ts:190](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/serializers.ts#L190)
1212

1313
Enum codec factory for handling string enum values
1414
Falls back to first enum value for invalid inputs
@@ -17,7 +17,7 @@ Falls back to first enum value for invalid inputs
1717

1818
### T
1919

20-
`T` _extends_ `string`
20+
`T` *extends* `string`
2121

2222
String literal union type
2323

‎docs/api/functions/createHistoryAdapter.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / createHistoryAdapter
66

77
# Function: createHistoryAdapter()
88

99
> **createHistoryAdapter**(): [`QueryAdapter`](../type-aliases/QueryAdapter.md)
1010
11-
Defined in: [adapters/history-adapter.ts:32](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/adapters/history-adapter.ts#L32)
11+
Defined in: [adapters/history-adapter.ts:32](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/adapters/history-adapter.ts#L32)
1212

1313
Creates a query adapter that uses the browser's History API for URL parameters
1414

‎docs/api/functions/createJsonCodec.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / createJsonCodec
66

77
# Function: createJsonCodec()
88

99
> **createJsonCodec**\<`T`\>(): [`QueryCodec`](../type-aliases/QueryCodec.md)\<`null` \| `T`\>
1010
11-
Defined in: [serializers.ts:113](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/serializers.ts#L113)
11+
Defined in: [serializers.ts:113](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/serializers.ts#L113)
1212

1313
JSON codec factory for handling complex objects
1414
Returns null for invalid JSON

‎docs/api/functions/createRuntimeEnvironment.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / createRuntimeEnvironment
66

77
# Function: createRuntimeEnvironment()
88

99
> **createRuntimeEnvironment**(): [`RuntimeEnvironment`](../type-aliases/RuntimeEnvironment.md)
1010
11-
Defined in: [utils/core-helpers.ts:19](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/utils/core-helpers.ts#L19)
11+
Defined in: [utils/core-helpers.ts:19](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/utils/core-helpers.ts#L19)
1212

1313
Creates a runtime environment object with safe property access
1414

‎docs/api/functions/createVueQsPlugin.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / createVueQsPlugin
66

77
# Function: createVueQsPlugin()
88

99
> **createVueQsPlugin**(`options`): `object`
1010
11-
Defined in: [adapter-context.ts:81](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/adapter-context.ts#L81)
11+
Defined in: [adapter-context.ts:81](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/adapter-context.ts#L81)
1212

1313
Creates a Vue.js plugin for vue-qs that automatically provides the query adapter
1414

‎docs/api/functions/createVueRouterAdapter.md‎

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

3-
---
3+
***
44

55
[vue-qs](../README.md) / createVueRouterAdapter
66

77
# Function: createVueRouterAdapter()
88

99
> **createVueRouterAdapter**(`vueRouter`, `options`): [`QueryAdapter`](../type-aliases/QueryAdapter.md)
1010
11-
Defined in: [adapters/vue-router-adapter.ts:33](https://github.com/iamsomraj/vue-qs/blob/e1f88d67026c08e56605a693106ef6b717bd39ad/src/adapters/vue-router-adapter.ts#L33)
11+
Defined in: [adapters/vue-router-adapter.ts:33](https://github.com/iamsomraj/vue-qs/blob/b89690c4cfcb78328e659968e3c7235730988be4/src/adapters/vue-router-adapter.ts#L33)
1212

1313
Creates a query adapter that integrates with Vue Router
1414
This adapter reads and writes query parameters through Vue Router's API

0 commit comments

Comments
 (0)