Skip to content

Commit a801686

Browse files
authored
docs(build-id): add code block example (denoland#3600)
Adds a module doc and code block to help satisfy JSR's scoring. Suggestions for alternatives or improvements very welcome. Part of denoland#3597
1 parent 42d7d9f commit a801686

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

packages/build-id/mod.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
/**
2+
* Don't use this package directly. It's considered internal for Fresh.
3+
*
4+
* @example
5+
* ```ts
6+
* // `BUILD_ID` is based on the `DENO_DEPLOYMENT_ID` environment variable.
7+
* ```
8+
*
9+
* @see https://fresh.deno.dev/docs/deployment/docker
10+
*
11+
* @module
12+
* @private
13+
*/
14+
115
import { encodeHex } from "@std/encoding/hex";
216

317
export const DENO_DEPLOYMENT_ID: string | undefined = Deno.env.get(

0 commit comments

Comments
 (0)