Skip to content

Commit

Permalink
feat: add types (#53)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielroe authored Sep 6, 2022
1 parent 61e7738 commit 55bb8f4
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
57 changes: 57 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import { pki } from 'node-forge'

declare interface SelfsignedOptions {
/**
* The number of days before expiration
*
* @default 365 */
days?: number
/**
* the size for the private key in bits
* @default 1024
*/
keySize?: number
/**
* additional extensions for the certificate
*/
extensions?: string[]
/**
* The signature algorithm sha256 or sha1
* @default "sha1"
*/
algorithm?: string
/**
* include PKCS#7 as part of the output
* @default false
*/
pkcs7?: boolean
/**
* generate client cert signed by the original key
* @default false
*/
clientCertificate?: undefined
/**
* client certificate's common name
* @default "John Doe jdoe123"
*/
clientCertificateCN?: string
}

declare interface GenerateResult {
private: string
public: string
cert: string
fingerprint: string
}

declare function generate(
attrs?: pki.CertificateField[],
opts?: SelfsignedOptions
): GenerateResult

declare function generate(
attrs?: pki.CertificateField[],
opts?: SelfsignedOptions,
/** Optional callback, if not provided the generation is synchronous */
done?: (err: undefined | Error, result: GenerateResult) => any
): void
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "2.0.1",
"description": "Generate self signed certificates private and public keys",
"main": "index.js",
"types": "index.d.ts",
"scripts": {
"test": "mocha -t 5000"
},
Expand Down

0 comments on commit 55bb8f4

Please sign in to comment.