Skip to content

CHANGELOG.md

Latest commit

 

History

History
262 lines (170 loc) · 10.6 KB

CHANGELOG.md

File metadata and controls

262 lines (170 loc) · 10.6 KB
Raw

Changelog

2.1.0

Features

Bugfixes

  • Make Element.attributes iterable - @jdanyow, pull/47

    Fixing a bug in the type definitions that prevents writing valid code like this:

    rewriter.on('bla', {
  element: element => {
    for (const [name, value] of element.attributes) {

Maintenance

  • Update README.md instructions to avoid typescript error - @jeremistadler, pull/60 Add empty export to bindings.d.ts example to avoid an typescript error

  • Add a GitHub action to lint the Markdown - @jbampton,pull/51

  • Fix spelling - @jbampton,pull/50

  • Add CODEOWNERS - @ispivey, [pull/49] This will ensure we have default reviewers.

  • Add prettier and typescript as devDependencies - @1000hz, pull/46 Automated formatting via prettier

⌨️ 2.0.0

Breaking Changes

  • Types now only provided via automatic type inclusion, rather than explicit import - @jdanyow, issue/33, pull/34

    Users should no longer use an empty import to include workers-types, which used to be the recommendation in the README.

    Remove this from your code:

    import {} from '@cloudflare/workers-types'

    And instead include the types explicitly in your TypeScript configuration compiler options:

    {
  "compilerOptions": {
    "types": ["@cloudflare/workers-types"]
  }
}

Features

  • Add Cache behavior modifiers to outbound Requests - @trjstewart, issue/22, pull/17

    When constructing a request, you can now include the following cache-manipulating properties in the initializer dictionary:

    // Force response to be cached for 300 seconds.
fetch(event.request, { cf: { cacheTtl: 300 } })

// Force response to be cached for 86400 seconds for 200 status codes, 1 second for 404, and do not cache 500 errors
fetch(request, { cf: { cacheTtlByStatus: { '200-299': 86400, '404': 1, '500-599': 0 } } })

    Read more about these properties in the Request docs.

  • Add support for caches.default - @ispivey, @ashnewmanjones, issue/8, pull/21

    The Workers runtime exposes a default global cache as caches.default, accessed like:

    let cache = caches.default

    This is an extension to the Service Workers spec for CacheStorage, and thus needed to be added explicitly to our type definitions.

  • Add missing properties to inbound Request cf object - @ispivey, @brycematheson1234, issue/23, pull/24, pull/35

    Adds:

    • clientTcpRtt
    • metroCode
    • botManagement.score
    • botManagement.staticResource
    • botManagement.verifiedBot

    Makes most geolocation properties optional, because they are not guaranteed to be set on every request.

    Changes the type of asn from string to number.

  • Adds cf.cacheKey property to RequestInit - @ispivey, issue/22, pull/28

    Adds the cacheKey property of the cf object to the RequestInit interface.

  • Allow passing another Request as the init arg to Request constructor - @ispivey, issue/15, pull/18

    Previously, this pattern wasn't allowed:

    new Request(parsedUrl.toString(), request)

    This is because the cf object on inbound Request objects, and that expected in the init dictionary arg to the Request constructor, have a different shape.

    This change creates explicit IncomingRequestCfProperties (inbound) and RequestInitCfProperties (outbound) interfaces, and updates the Request constructor to accept either type:

    interface RequestInit {
  cf?: RequestInitCfProperties | IncomingRequestCfProperties
}

    Read more about the Request constructor in the Request docs.

  • Add CfRequestInit type - @third774, issue/37, pull/44

    Because of the union mentioned above, if an object is declared as RequestInit and sets the cf property, subproperties of cf can not later be reassigned. For this scenario, a more specific CfRequestInit type has been introduced to use instead of RequestInit that doesn't exhibit the same assignability issues.

  • Add iterable methods to FormData, Headers, and URLSearchParams - @ispivey, issue/25, pull/26

    The iterable methods entries(), keys() and values() are not present on these three types in lib.webworker.d.ts. They are instead supplied in lib.dom.iterable.d.ts.

    However, as discussed in this issue on the TypeScript repo, lib.dom.d.ts and lib.webworker.d.ts have conflicting type definitions, and the maintainers hope to solve this issue by refactoring shared components into a new web.iterable.d.ts lib: microsoft/TypeScript#32435 (comment)

    Until then, we will include the iterable methods supported by Workers in our own type definitions.

Bugfixes

  • Remove selector parameter from onDocument() - @jdanyow, pull/41

    The type signature for HTMLRewriter's onDocument() method previously erroneously included a selector parameter as its first argument. This has been removed.

  • Make KVNamespace.list() options argument optional - @motiejunas, pull/10

    Previously, the KVNamespace interface required that callers provide an empty options object when listing all the keys in a namespace, like so:

    await NAMESPACE.list({})

    However, this argument is not actually required. This change updates the interface to match the runtime.

Maintenance

  • Add a Release Checklist - @ispivey, issue/20, pull/27

    As we onboard more contributors, we're documenting release procedures.

  • Add BSD-3 License - @ispivey, issue/31, pull/30, pull/40

    As we transition this to a project supported by the Cloudflare Workers team, we're releasing the code under a BSD-3 license. Thanks to all the contributors for their help!