Skip to content

Commit 0af467f

Browse files
committed
Updated docs
1 parent ea701a2 commit 0af467f

File tree

3 files changed

+5
-95
lines changed

3 files changed

+5
-95
lines changed

DOCUMENTATION.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,3 @@
22

33
You can see below the API reference of this module.
44

5-
### `interopDefaultLegacy()`
6-
#__PURE__
7-
8-
#__PURE__
9-
10-
### `etAugmentedNamespace()`
11-
12-
### `parseUrl(url, normalize)`
13-
Parses the input url.
14-
15-
**Note**: This *throws* if invalid urls are provided.
16-
17-
#### Params
18-
19-
- **String** `url`: The input url.
20-
- **Boolean|Object** `normalize`: Whether to normalize the url or not. Default is `false`. If `true`, the url will
21-
be normalized. If an object, it will be the
22-
options object sent to [`normalize-url`](https://github.com/sindresorhus/normalize-url).
23-
24-
For SSH urls, normalize won't work.
25-
26-
#### Return
27-
- **Object** An object containing the following fields:
28-
- `protocols` (Array): An array with the url protocols (usually it has one element).
29-
- `protocol` (String): The first protocol, `"ssh"` (if the url is a ssh url) or `"file"`.
30-
- `port` (null|Number): The domain port.
31-
- `resource` (String): The url domain (including subdomains).
32-
- `host` (String): The fully qualified domain name of a network host, or its IP address.
33-
- `user` (String): The authentication user (usually for ssh urls).
34-
- `pathname` (String): The url pathname.
35-
- `hash` (String): The url hash.
36-
- `search` (String): The url querystring value.
37-
- `href` (String): The input url.
38-
- `query` (Object): The url querystring, parsed as object.
39-
- `parse_failed` (Boolean): Whether the parsing failed or not.
40-
41-
### GIT_RE
42-
43-
([a-zA-Z_][a-zA-Z0-9_-]{0,31}) Try to match the user
44-
([\w\.\-@]+) Match the host/resource
45-
(([\~,\.\w,\-,\_,\/,\s]|%[0-9A-Fa-f]{2})+?(?:\.git|\/)?) Match the path, allowing spaces/white
46-

README.md

Lines changed: 3 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -151,53 +151,6 @@ console.log(parseUrl("git@github.com:IonicaBizau/git-stats.git", false))
151151

152152

153153

154-
## :memo: Documentation
155-
156-
157-
### `interopDefaultLegacy()`
158-
#__PURE__
159-
160-
#__PURE__
161-
162-
### `etAugmentedNamespace()`
163-
164-
### `parseUrl(url, normalize)`
165-
Parses the input url.
166-
167-
**Note**: This *throws* if invalid urls are provided.
168-
169-
#### Params
170-
171-
- **String** `url`: The input url.
172-
- **Boolean|Object** `normalize`: Whether to normalize the url or not. Default is `false`. If `true`, the url will
173-
be normalized. If an object, it will be the
174-
options object sent to [`normalize-url`](https://github.com/sindresorhus/normalize-url).
175-
176-
For SSH urls, normalize won't work.
177-
178-
#### Return
179-
- **Object** An object containing the following fields:
180-
- `protocols` (Array): An array with the url protocols (usually it has one element).
181-
- `protocol` (String): The first protocol, `"ssh"` (if the url is a ssh url) or `"file"`.
182-
- `port` (null|Number): The domain port.
183-
- `resource` (String): The url domain (including subdomains).
184-
- `host` (String): The fully qualified domain name of a network host, or its IP address.
185-
- `user` (String): The authentication user (usually for ssh urls).
186-
- `pathname` (String): The url pathname.
187-
- `hash` (String): The url hash.
188-
- `search` (String): The url querystring value.
189-
- `href` (String): The input url.
190-
- `query` (Object): The url querystring, parsed as object.
191-
- `parse_failed` (Boolean): Whether the parsing failed or not.
192-
193-
### GIT_RE
194-
195-
([a-zA-Z_][a-zA-Z0-9_-]{0,31}) Try to match the user
196-
([\w\.\-@]+) Match the host/resource
197-
(([\~,\.\w,\-,\_,\/,\s]|%[0-9A-Fa-f]{2})+?(?:\.git|\/)?) Match the path, allowing spaces/white
198-
199-
200-
201154

202155

203156

@@ -278,6 +231,7 @@ If you are using this library in one of your projects, add it in this list. :spa
278231
- `@amiruldev/wajs`
279232
- `@angga30prabu/wa-modified`
280233
- `@apardellass/react-native-audio-stream`
234+
- `@appconda/app`
281235
- `@appconda/next`
282236
- `@aysea/react-native-ui-library`
283237
- `@azalpacir/react-native-dhp-printer`
@@ -288,7 +242,6 @@ If you are using this library in one of your projects, add it in this list. :spa
288242
- `@cs6/react-native-test-native-view-library`
289243
- `@damruravihara/react-native-testing-package`
290244
- `@dataparty/api`
291-
- `@drakedeatonuk/rschedule`
292245
- `@enkeledi/react-native-week-month-date-picker`
293246
- `@felipesimmi/react-native-datalogic-module`
294247
- `@foundernetes/machines`
@@ -315,7 +268,6 @@ If you are using this library in one of your projects, add it in this list. :spa
315268
- `@mergulhao/wa-automate`
316269
- `@mockswitch/cli`
317270
- `@navabi/react-native-ssl-pinning`
318-
- `@ndla/source-map-resolver`
319271
- `@notnuzzel/crawl`
320272
- `@oiti/rn-liveness2d`
321273
- `@open-wa/wa-automate`
@@ -390,7 +342,6 @@ If you are using this library in one of your projects, add it in this list. :spa
390342
- `deploy-versioning`
391343
- `design-system-trial-milyasbpa`
392344
- `dogandev-simple-toast`
393-
- `domaincomponent`
394345
- `egg-muc-custom-loader`
395346
- `eval-spider`
396347
- `fawaterak-online-payment`
@@ -453,6 +404,7 @@ If you are using this library in one of your projects, add it in this list. :spa
453404
- `npm_one_2_2`
454405
- `npm_qwerty`
455406
- `nuxtpaginations`
407+
- `octopulse`
456408
- `parse-db-uri`
457409
- `pasbeaucoupmoinsrave`
458410
- `patepangdeui`
@@ -512,7 +464,6 @@ If you are using this library in one of your projects, add it in this list. :spa
512464
- `react-native-dummy-view`
513465
- `react-native-escape`
514466
- `react-native-fedlight-dsm`
515-
- `react-native-flyy`
516467
- `react-native-get-countries`
517468
- `react-native-ghn-ekyc`
518469
- `react-native-ideo-rn-notifications`
@@ -603,6 +554,7 @@ If you are using this library in one of your projects, add it in this list. :spa
603554
- `react-native-transtracker-library`
604555
- `react-native-ui-components-library`
605556
- `react-native-uvc-camera-android`
557+
- `react-native-vanguard-sdk`
606558
- `react-native-version-app`
607559
- `react-native-volume-phisical`
608560
- `react-native-withframework-check`

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy