Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

> **new DynamicURL**(`url`): `DynamicURL`


#### Parameters

##### url
Expand All @@ -23,7 +22,6 @@

> **resolve**(): `string`


Resolves and returns the final URL as a string.

#### Returns
Expand All @@ -40,12 +38,11 @@ url.setRouteParams({ citizen: "robespierre", hero: "ironman" });
console.log(url.resolve()); // "https://example.com/robespierre/ironman"
```

---
***

### setQueryParams()

> **setQueryParams**(`query`): `DynamicURL`

> **setQueryParams**(`query`, `options?`): `DynamicURL`

Takes a query object and appends it to the URL as a query string.

Expand All @@ -57,6 +54,10 @@ Takes a query object and appends it to the URL as a query string.

An object representing the query parameters.

##### options?

`IStringifyQueryOptions`

#### Returns

`DynamicURL`
Expand All @@ -69,13 +70,12 @@ url.setQueryParams({ citizen: "robespierre", hero: "ironman" });
console.log(url.resolve()); // "https://example.com?citizen=robespierre&hero=ironman"
```

---
***

### setRouteParams()

> **setRouteParams**(`replaceValue`): `DynamicURL`


Replaces route parameters in the URL with the provided values.

#### Parameters
Expand Down
3 changes: 0 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,6 @@
"typescript-eslint": "^8.53.0",
"vitest": "^4.0.17"
},
"dependencies": {
"qs": "^6.14.1"
},
"scripts": {
"--- 🎣 Hooks ---": "",
"prepare": "husky",
Expand Down
167 changes: 0 additions & 167 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading