chore(main): release 3.9.0 (#728)

Author: JakeChampion

CHANGELOG.md

@@ -1,6 +1,21 @@
 # Changelog
 
 
+## 3.9.0 (2024-03-02)
+
+
+### Added
+
+* Add a EdgeRateLimiter JavaScript Class which enables edge-rate-limiting by utilising a RateCounter and a PenaltyBox instance ([#732](https://github.com/fastly/js-compute-runtime/issues/732)) ([4e81fc7](https://github.com/fastly/js-compute-runtime/commit/4e81fc7dbec33a5a90743e389642e0ced5294ff1))
+* Add a PenaltyBox JavaScript Class which can be used standalone for adding and checking if an entry is in the penalty-box ([#731](https://github.com/fastly/js-compute-runtime/issues/731)) ([bfe1e15](https://github.com/fastly/js-compute-runtime/commit/bfe1e15460cb2aa0da3cfa356fbf23d38f5af5ba))
+* Add a RateCounter JavaScript Class which can be used standalone for counting and rate calculations ([#730](https://github.com/fastly/js-compute-runtime/issues/730)) ([0f6036f](https://github.com/fastly/js-compute-runtime/commit/0f6036f02f497345df01dbce731eb502fd406d27))
+* implement and expose JavaScript classes for Fastly's Compute Core Cache feature set ([#566](https://github.com/fastly/js-compute-runtime/issues/566)) ([94f4038](https://github.com/fastly/js-compute-runtime/commit/94f4038df7ca2bfd8beef964865eb7f900b1bc04))
+
+
+### Fixed
+
+* disable the portable-baseline-tier for async functions for now ([#733](https://github.com/fastly/js-compute-runtime/issues/733)) ([4928243](https://github.com/fastly/js-compute-runtime/commit/4928243a380adfb6073a909e41ab7eb4c0d569b4))
+
 ## 3.8.3 (2024-02-21)
 
 

documentation/docs/fastly:cache/CacheEntry/age.mdx

@@ -0,0 +1,23 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.age
+
+The **`age`** method of the `CacheEntry` interface returns the current age in milliseconds of the cached item.
+
+## Syntax
+
+```js
+age()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `number` which represents the current age in milliseconds of the cached item.

documentation/docs/fastly:cache/CacheEntry/body.mdx

@@ -0,0 +1,29 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.body
+
+The **`body`** method of the `CacheEntry` interface retrieves the cached item contents as a `ReadableStream`.
+
+Only one stream can be active at a time for a given `CacheEntry`. An error will be thrown if a stream is already active for this `CacheEntry`.
+
+## Syntax
+
+```js
+body(options)
+```
+
+### Parameters
+
+- `options` _: object_ __optional__
+  - `start` _: number_
+    - The offset from which to start the range.
+  - `end` _: number_
+    - How long the range should be.
+
+### Return value
+
+A `ReadableStream` which contains the cached item contents.

documentation/docs/fastly:cache/CacheEntry/close.mdx

@@ -0,0 +1,23 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.close
+
+The **`close`** method of the `CacheEntry` interface closes the connection to the cache for this `CacheEntry`.
+
+## Syntax
+
+```js
+close()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+`undefined`

documentation/docs/fastly:cache/CacheEntry/hits.mdx

@@ -0,0 +1,25 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.hits
+
+The **`hits`** method of the `CacheEntry` interface returns the amount of cache hits for the cached item.
+
+Note: this hit count only reflects the view of the server that supplied the cached item. Due to clustering, this count may vary between potentially many servers within the data center where the item is cached. See the [clustering documentation](https://developer.fastly.com/learning/vcl/clustering/) for details, though note that the exact caching architecture of Compute is different from VCL services.
+
+## Syntax
+
+```js
+hits()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `number` which represents the number of cache hits to this cached item.

documentation/docs/fastly:cache/CacheEntry/length.mdx

@@ -0,0 +1,27 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.length
+
+The **`length`** method of the `CacheEntry` interface returns the size in bytes of the cached item, if known, otherwise returns `null` if the length is currently unknown.
+
+The length of the cached item may be unknown if the item is currently being streamed into the cache without a fixed length.
+
+## Syntax
+
+```js
+length()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `number` or `null` which represents the current length of the cached item.
+
+`null` is returned if the length is currently unknown.

documentation/docs/fastly:cache/CacheEntry/maxAge.mdx

@@ -0,0 +1,23 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.maxAge
+
+The **`maxAge`** method of the `CacheEntry` interface returns the time in milliseconds for which the cached item is considered fresh.
+
+## Syntax
+
+```js
+maxAge()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `number` which represents the time in milliseconds for which the cached item is considered fresh.

documentation/docs/fastly:cache/CacheEntry/staleWhileRevalidate.mdx

@@ -0,0 +1,23 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.staleWhileRevalidate
+
+The **`staleWhileRevalidate`** method of the `CacheEntry` interface returns the time in milliseconds for which a cached item can safely be used despite being considered stale.
+
+## Syntax
+
+```js
+staleWhileRevalidate()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `number` which represents the time in milliseconds for which a cached item can safely be used despite being considered stale.

documentation/docs/fastly:cache/CacheEntry/state.mdx

@@ -0,0 +1,23 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.state
+
+The **`state`** method of the `CacheEntry` interface returns a `CacheState` instance which reflects the current state of this `CacheEntry` instance.
+
+## Syntax
+
+```js
+state()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `CacheState` instance which reflects the current state of this `CacheEntry` instance.

documentation/docs/fastly:cache/CacheEntry/userMetadata.mdx

@@ -0,0 +1,23 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheEntry.userMetadata
+
+The **`userMetadata`** method of the `CacheEntry` interface returns the user-controlled metadata associated with the cached item.
+
+## Syntax
+
+```js
+userMetadata()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+An `ArrayBuffer` which contains the user-controlled metadata associated with the cached item.

documentation/docs/fastly:cache/CacheState/found.mdx

@@ -0,0 +1,25 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheState.found
+
+The **`found`** method of the `CacheState` interface returns `true` if a cached item was located.
+
+Even if an cached item is found, the cached item might be stale and require updating. Use `mustInsertOrUpdate()` to determine whether this transaction client is expected to update the cached item.
+
+## Syntax
+
+```js
+found()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `boolean` which represents whether a cached item was located or not.

documentation/docs/fastly:cache/CacheState/mustInsertOrUpdate.mdx

@@ -0,0 +1,24 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheState.mustInsertOrUpdate
+
+The **`mustInsertOrUpdate`** method of the `CacheState` interface returns `true` if a fresh cache item was not found, and this transaction client is expected to insert a new item or update a stale item.
+
+
+## Syntax
+
+```js
+mustInsertOrUpdate()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `boolean` which represents whether a fresh cached item was found not.

documentation/docs/fastly:cache/CacheState/stale.mdx

@@ -0,0 +1,25 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheState.stale
+
+The **`stale`** method of the `CacheState` interface returns `true` if the cached item is stale.
+
+A cached item is stale if its age is greater than its `maxAge` period.
+
+## Syntax
+
+```js
+stale()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `boolean` which represents whether the cached item is stale or not.

documentation/docs/fastly:cache/CacheState/usable.mdx

@@ -0,0 +1,25 @@
+---
+hide_title: false
+hide_table_of_contents: false
+pagination_next: null
+pagination_prev: null
+---
+# CacheState.usable
+
+The **`usable`** method of the `CacheState` interface returns `true` if the cached item is usable.
+
+A cached item is usable if its age is less than the sum of the `maxAge` and `staleWhileRevalidate` periods.
+
+## Syntax
+
+```js
+usable()
+```
+
+### Parameters
+
+None.
+
+### Return value
+
+A `boolean` which represents whether a cached item is usable or not.