Skip to content

Commit

Permalink
add module docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ycmjason committed Oct 12, 2024
1 parent dd4b73f commit d1f41e3
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 4 deletions.
2 changes: 1 addition & 1 deletion deno.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@fishballpkg/acme",
"version": "0.5.3",
"version": "0.5.4",
"exports": {
".": "./src/mod.ts",
"./Dns01ChallengeUtils": "./src/Dns01ChallengeUtils.ts",
Expand Down
6 changes: 6 additions & 0 deletions src/Dns01ChallengeUtils.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @module
*
* Utility functions to help you with `dns-01` challenge
*/

/**
* Lookup the DNS `TXT` record for `domain` every `interval`
* (in ms, default: 5000) until the record matches `pollUntil`.
Expand Down
21 changes: 18 additions & 3 deletions src/mod.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
/**
* @module
*
* A zero-dependency, minimalistic, opiniated Automatic Certificate Management Environment
* (ACME) client written in TypeScript from scratch. We aim to simplify certificate
* generation by removing the need to deal with cryptographic options, external tools like
* OpenSSL, or other low-level details.
*/

import * as Dns01ChallengeUtils from "./Dns01ChallengeUtils.ts";

export * from "./AcmeAccount.ts";
export * from "./AcmeAuthorization.ts";
export * from "./AcmeChallenge.ts";
export * from "./AcmeClient.ts";
export * from "./AcmeOrder.ts";

/** Utility functions to help you with `dns-01` challenge */
export * as Dns01ChallengeUtils from "./Dns01ChallengeUtils.ts";

export * from "./ACME_DIRECTORY_URLS.ts";

export {
/**
* Utility functions to help you with `dns-01` challenge
*/
Dns01ChallengeUtils,
};
6 changes: 6 additions & 0 deletions src/utils/generateCSR.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @module
*
* Utility function to generate a Certificate Signing Request (CSR) in DER format
*/

import { splitAtIndex } from "./array.ts";
import { ASN1 } from "./ASN1.ts";
import { sign } from "./crypto.ts";
Expand Down

0 comments on commit d1f41e3

Please sign in to comment.