Skip to content

docs: document supported content encodings - #463

Open
asllanmaciel wants to merge 1 commit into
web-push-libs:masterfrom
asllanmaciel:docs/content-encoding-discovery
Open

asllanmaciel wants to merge 1 commit into
web-push-libs:masterfrom
asllanmaciel:docs/content-encoding-discovery

Conversation

@asllanmaciel

Copy link
Copy Markdown
Contributor

Addresses the discoverability part of #381.

ContentEncoding is now a public backed enum, so applications can derive the library-supported values with ContentEncoding::cases() instead of duplicating a private/hard-coded list. This updates the README to show that approach and clarifies that a selected contentEncoding should be supported by both the browser and this library.

The automatic-negotiation API proposed in #381 remains a separate design choice; this PR only documents the capability that exists today.

Validation:

  • git diff --check
  • executed the documented PHP enum mapping against the current source; result: [aesgcm,aes128gcm]

Docs-only change; no production code changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant