Skip to content

Commit cb7da35

Browse files
iamsomrajiamsomraj
committed
chore: update documentation for vue-qs v0.1.15
- Bump version in various documentation files from v0.1.14 to v0.1.15. - Update links to source code in documentation to reflect changes in line numbers. - Remove deprecated HistoryAdapterResult type alias and create a new definition for it. - Adjust definitions and descriptions for several types and interfaces to ensure accuracy. - Update serializers for boolean, date, number, and string codecs to reflect new line numbers.
1 parent c6723d9 commit cb7da35

Some content is hidden

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

43 files changed

+127
-142
lines changed

‎docs/api/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
**vue-qs v0.1.14**
1+
**vue-qs v0.1.15**
22

3-
---
3+
***
44

5-
# vue-qs v0.1.14
5+
# vue-qs v0.1.15
66

77
## Namespaces
88

@@ -12,11 +12,11 @@
1212

1313
- [VueQueryPluginOptions](interfaces/VueQueryPluginOptions.md)
1414
- [HistoryAdapterOptions](interfaces/HistoryAdapterOptions.md)
15-
- [HistoryAdapterResult](interfaces/HistoryAdapterResult.md)
1615
- [VueRouterAdapterOptions](interfaces/VueRouterAdapterOptions.md)
1716

1817
## Type Aliases
1918

19+
- [HistoryAdapterResult](type-aliases/HistoryAdapterResult.md)
2020
- [QueryParser](type-aliases/QueryParser.md)
2121
- [QuerySerializer](type-aliases/QuerySerializer.md)
2222
- [QueryCodec](type-aliases/QueryCodec.md)

‎docs/api/functions/areValuesEqual.md‎

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

33
***
44

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

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

1313
Safely compares two values for equality
1414

‎docs/api/functions/buildSearchString.md‎

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

33
***
44

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

99
> **buildSearchString**(`queryObject`): `string`
1010
11-
Defined in: [utils/core-helpers.ts:57](https://github.com/iamsomraj/vue-qs/blob/33788ce453ede405848f8283c5f38c6323ad5403/src/utils/core-helpers.ts#L57)
11+
Defined in: [utils/core-helpers.ts:57](https://github.com/iamsomraj/vue-qs/blob/c6723d94881f5a2550faa61b4e51be4507991c23/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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.14**](../README.md)
1+
[**vue-qs v0.1.15**](../README.md)
22

33
***
44

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

99
> **createArrayCodec**\<`T`\>(`elementCodec`, `delimiter`): [`QueryCodec`](../type-aliases/QueryCodec.md)\<`T`[]\>
1010
11-
Defined in: [serializers.ts:147](https://github.com/iamsomraj/vue-qs/blob/33788ce453ede405848f8283c5f38c6323ad5403/src/serializers.ts#L147)
11+
Defined in: [serializers.ts:148](https://github.com/iamsomraj/vue-qs/blob/c6723d94881f5a2550faa61b4e51be4507991c23/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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.14**](../README.md)
1+
[**vue-qs v0.1.15**](../README.md)
22

33
***
44

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

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

1313
Enum codec factory for handling string enum values
1414
Falls back to first enum value for invalid inputs

‎docs/api/functions/createHistoryAdapter.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
1-
[**vue-qs v0.1.14**](../README.md)
1+
[**vue-qs v0.1.15**](../README.md)
22

3-
---
3+
***
44

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

77
# Function: createHistoryAdapter()
88

99
> **createHistoryAdapter**(`options`): [`QueryAdapter`](../type-aliases/QueryAdapter.md)
1010
11-
Defined in: [adapters/history-adapter.ts:114](https://github.com/iamsomraj/vue-qs/blob/33788ce453ede405848f8283c5f38c6323ad5403/src/adapters/history-adapter.ts#L114)
11+
Defined in: [adapters/history-adapter.ts:108](https://github.com/iamsomraj/vue-qs/blob/c6723d94881f5a2550faa61b4e51be4507991c23/src/adapters/history-adapter.ts#L108)
1212

13-
Creates a query adapter that uses the browser's History API
14-
This adapter is SSR-safe and maintains an in-memory cache on the server
13+
Creates a query adapter that uses the browser's History API for URL parameters
1514

1615
## Parameters
1716

@@ -25,7 +24,7 @@ Configuration options for the adapter
2524

2625
[`QueryAdapter`](../type-aliases/QueryAdapter.md)
2726

28-
Query adapter instance for browser history-based parameter management
27+
Query adapter instance
2928

3029
## Example
3130

‎docs/api/functions/createJsonCodec.md‎

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

33
***
44

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

99
> **createJsonCodec**\<`T`\>(): [`QueryCodec`](../type-aliases/QueryCodec.md)\<`null` \| `T`\>
1010
11-
Defined in: [serializers.ts:112](https://github.com/iamsomraj/vue-qs/blob/33788ce453ede405848f8283c5f38c6323ad5403/src/serializers.ts#L112)
11+
Defined in: [serializers.ts:113](https://github.com/iamsomraj/vue-qs/blob/c6723d94881f5a2550faa61b4e51be4507991c23/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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.14**](../README.md)
1+
[**vue-qs v0.1.15**](../README.md)
22

33
***
44

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

99
> **createRuntimeEnvironment**(): [`RuntimeEnvironment`](../type-aliases/RuntimeEnvironment.md)
1010
11-
Defined in: [utils/core-helpers.ts:19](https://github.com/iamsomraj/vue-qs/blob/33788ce453ede405848f8283c5f38c6323ad5403/src/utils/core-helpers.ts#L19)
11+
Defined in: [utils/core-helpers.ts:19](https://github.com/iamsomraj/vue-qs/blob/c6723d94881f5a2550faa61b4e51be4507991c23/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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.14**](../README.md)
1+
[**vue-qs v0.1.15**](../README.md)
22

33
***
44

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

99
> **createVueQsPlugin**(`options`): `object`
1010
11-
Defined in: [adapter-context.ts:80](https://github.com/iamsomraj/vue-qs/blob/33788ce453ede405848f8283c5f38c6323ad5403/src/adapter-context.ts#L80)
11+
Defined in: [adapter-context.ts:81](https://github.com/iamsomraj/vue-qs/blob/c6723d94881f5a2550faa61b4e51be4507991c23/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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**vue-qs v0.1.14**](../README.md)
1+
[**vue-qs v0.1.15**](../README.md)
22

33
***
44

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

99
> **createVueRouterAdapter**(`vueRouter`, `options`): [`QueryAdapter`](../type-aliases/QueryAdapter.md)
1010
11-
Defined in: [adapters/vue-router-adapter.ts:32](https://github.com/iamsomraj/vue-qs/blob/33788ce453ede405848f8283c5f38c6323ad5403/src/adapters/vue-router-adapter.ts#L32)
11+
Defined in: [adapters/vue-router-adapter.ts:33](https://github.com/iamsomraj/vue-qs/blob/c6723d94881f5a2550faa61b4e51be4507991c23/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)