File tree Expand file tree Collapse file tree 3 files changed +10
-4
lines changed Expand file tree Collapse file tree 3 files changed +10
-4
lines changed Original file line number Diff line number Diff line change @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55The format is based on [ Keep a Changelog] ( https://keepachangelog.com/en/1.0.0/ ) ,
66and this project adheres to [ Semantic Versioning] ( https://semver.org/spec/v2.0.0.html ) .
77
8+ ## [ Unreleased]
9+
10+ ### Fixed
11+
12+ - Improved JSDoc
13+
814## [ 0.1.0] - 2023-04-14
915
1016### Added
Original file line number Diff line number Diff line change @@ -158,7 +158,7 @@ Retrieves navigation data with the given key and optional query parameters.
158158| Parameter | Required? | Type | Default | Description |
159159| :-----------------| :----------| :----------| :--------| :-------------------------------------------|
160160| ` key ` | Yes | ` string ` | - | The key of the navigation to retrieve. |
161- | ` params ` | No | ` Object ` | ` {} ` | The query parameters for the request. |
161+ | ` params ` | No | ` Object ` | - | The query parameters for the request. |
162162| ` params.depth ` | No | ` number ` | ` 1 ` | The maximum depth of the navigation. |
163163| ` params.excerpt ` | No | ` boolean ` | ` false ` | Whether to include excerpt data. |
164164| ` params.flat ` | No | ` boolean ` | ` false ` | Whether to return as list instead of tree. |
@@ -176,7 +176,7 @@ Retrieves snippet data with the given area name and optional query parameters.
176176| Parameter | Required? | Type | Default | Description |
177177| :--------------------------| :----------| :----------| :--------| :------------------------------------------|
178178| ` area ` | Yes | ` string ` | - | The name of the snippet area to retrieve. |
179- | ` params ` | No | ` Object ` | ` {} ` | The query parameters for the request. |
179+ | ` params ` | No | ` Object ` | - | The query parameters for the request. |
180180| ` params.includeExtension ` | No | ` boolean ` | ` false ` | Whether to include extension data. |
181181
182182#### Return value
Original file line number Diff line number Diff line change @@ -105,7 +105,7 @@ export default class Client {
105105 * Retrieves navigation data with the given key and optional query parameters.
106106 *
107107 * @param {string } key - The key of the navigation to retrieve.
108- * @param {Object } [params={} ] - The query parameters for the request.
108+ * @param {Object } [params] - The query parameters for the request.
109109 * @returns {Promise<Object> } A Promise that resolves to the navigation data.
110110 */
111111 getNavigationByKey ( key , params ) {
@@ -116,7 +116,7 @@ export default class Client {
116116 * Retrieves snippet data with the given area name and optional query parameters.
117117 *
118118 * @param {string } area - The name of the snippet area to retrieve.
119- * @param {Object } [params={} ] - The query parameters for the request.
119+ * @param {Object } [params] - The query parameters for the request.
120120 * @returns {Promise<Object> } A Promise that resolves to the snippet area data.
121121 */
122122 getSnippetByArea ( area , params ) {
You can’t perform that action at this time.
0 commit comments