Skip to content

Commit

Permalink
readying up for a release
Browse files Browse the repository at this point in the history
  • Loading branch information
evert committed Oct 3, 2024
1 parent 3d021d1 commit c02e1db
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "structured-headers",
"version": "2.0.0-alpha.1",
"description": "Implementation of RFC8941, structured headers for HTTP.",
"description": "Implementation of Structured Field Values for HTTP (RFC9651, RFC8941)",
"type": "module",
"exports": {
"import": "./dist/index.js",
Expand All @@ -22,6 +22,7 @@
"structured-header",
"structured-fields",
"structured fields",
"RFC9651",
"RFC8941",
"headers"
],
Expand Down
10 changes: 6 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Structured Headers parser for Javascript
========================================

This library is a parser and serializer for the [Structured Headers][1]
specification, a.k.a. "Structured Field Values for HTTP" (RFC8941).
This library implements a parser and serializer for the [Structured Field Values for HTTP][2]
specification. ([RFC9651][3], [RFC8941][1]).

This specification defines a standard serialization for complex HTTP header
values, including lists (arrays), dictionaries (maps) and also numbers,
booleans, and binary data.
booleans, binary data, timestamps and Unicode strings.

The library is written in Typescript, and the examples in this document are
too, but plain Javascript is also fully supported.
too, but plain Javascript is also fully supported. It ships with ESM and
CommonJS builds and has 0 dependencies.

Compatibility
-------------
Expand Down Expand Up @@ -249,3 +250,4 @@ of the api.

[1]: https://datatracker.ietf.org/doc/html/rfc8941
[2]: https://github.com/httpwg/structured-field-tests
[3]: https://www.rfc-editor.org/rfc/rfc9651.html

0 comments on commit c02e1db

Please sign in to comment.