Skip to content

Commit

Permalink
docs: document the two new constructor options for eik/service
Browse files Browse the repository at this point in the history
  • Loading branch information
wkillerud committed Aug 12, 2024
1 parent 7123b07 commit 2735cd8
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/reference/at-eik-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@ const service = new Service(options);

### options (optional)

| option | default | type | details |
| -------------------- | ------------------------ | -------- | ----------------------------------------------------------------------------------------- |
| sink | `null` | `object` | The [storage sink] you would like to use. |
| logger | `null` | `object` | An instance of the [pino logger](https://getpino.io/). |
| customSink | `null` | `object` | Deprecated. Use `sink`. |
| aliasCacheControl | `"public, max-age=1200"` | `string` | Cache-Control header to respond with when getting an [alias](/docs/dependencies/aliases). |
| notFoundCacheControl | `"public, max-age=5"` | `string` | Cache-Control header to respond with when returning 404 Not Found. |
| option | default | type | details |
| -------------------- | ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| sink | `null` | `object` | The [storage sink] you would like to use. |
| logger | `null` | `object` | An instance of the [pino logger](https://getpino.io/). |
| customSink | `null` | `object` | Deprecated. Use `sink`. |
| aliasCacheControl | `"public, max-age=1200"` | `string` | Cache-Control header to respond with when getting an [alias](/docs/dependencies/aliases). |
| notFoundCacheControl | `"public, max-age=5"` | `string` | Cache-Control header to respond with when returning 404 Not Found. |
| pkgMaxFileSize | `10_000_000` | `number` | The limit in bytes before [PUT /pkg/:name/:version](/docs/server/http-api#upload-a-package) starts returning 413 Content Too Large. |
| mapMaxFileSize | `1_000_000` | `number` | The limit in bytes before [PUT /map/:name/:version](/docs/server/http-api#upload-an-import-map) starts returning 413 Content Too Large. |

## API

Expand Down

0 comments on commit 2735cd8

Please sign in to comment.