Skip to content

Refine URI and IRI parsing documentation #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdesrosiers merged 1 commit into from
Mar 3, 2026
Merged

Refine URI and IRI parsing documentation #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 28 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,14 @@ A [URI-reference](https://www.rfc-editor.org/rfc/rfc3986#section-4.1) may be
relative.

* **isUriReference**: (value: string) => boolean
* **parseUriReference**: (value: string) => IdentifierComponents
* **parseUriReference**: (value: string) => RelativeIdentifierComponents

### absolute-URI
An [absolute-URI](https://www.rfc-editor.org/rfc/rfc3986#section-4.3) is not
relative an does not include a fragment.

* **isAbsoluteUri**: (value: string) => boolean
* **parseAbsoluteUri**: (value: string) => IdentifierComponents
* **parseAbsoluteUri**: (value: string) => AbsoluteIdentifierComponents

### IRI
An IRI is not relative and may include a fragment.
Expand All @@ -97,24 +97,44 @@ An IRI is not relative and may include a fragment.
An IRI-reference may be relative.

* **isIriReference**: (value: string) => boolean
* **parseIriReference**: (value: string) => IdentifierComponents
* **parseIriReference**: (value: string) => RelativeIdentifierComponents

### absolute-IRI
An absolute-IRI is not relative an does not include a fragment.

* **isAbsoluteIri**: (value: string) => boolean
* **parseAbsoluteIri**: (value: string) => IdentifierComponents
* **parseAbsoluteIri**: (value: string) => AbsoluteIdentifierComponents

### Types
* **IdentifierComponents**
* **scheme**: string
* **authority**: string
* **userinfo**: string
* **userinfo**: string (optional)
* **host**: string
* **port**: string
* **port**: string (optional)
* **path**: string
* **query**: string
* **fragment**: string
* **query**: string (optional)
* **fragment**: string (optional)

* **RelativeIdentifierComponents**
* **scheme**: string (optional)
* **authority**: string (optional)
* **userinfo**: string (optional)
* **host**: string (optional)
* **port**: string (optional)
* **path**: string
* **query**: string (optional)
* **fragment**: string (optional)

* **AbsoluteIdentifierComponents**
* **scheme**: string
* **authority**: string
* **userinfo**: string (optional)
* **host**: string
* **port**: string (optional)
* **path**: string
* **query**: string (optional)


## Contributing
### Tests
Expand Down