From b5982f5a61a008bd1fbc26473cc43238c9e7cd26 Mon Sep 17 00:00:00 2001 From: Connor Burton Date: Sun, 17 Sep 2023 13:31:56 +0100 Subject: [PATCH 1/2] docs: remove build badge --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 3ab0419..4011f9e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # HMAC Auth Express [![npm](https://img.shields.io/npm/v/hmac-auth-express)](https://www.npmjs.com/package/hmac-auth-express) -[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/connorjburton/hmac-auth-express/Node.js%20CI)](https://github.com/connorjburton/hmac-auth-express/actions/workflows/ci.yml) [![GitHub](https://img.shields.io/github/license/connorjburton/hmac-auth-express)](https://github.com/connorjburton/hmac-auth-express/blob/master/LICENSE) This package provides [Express](https://expressjs.com/) middleware for [HMAC](https://en.wikipedia.org/wiki/HMAC) authentication. From 89bc36c75ef4ba5ce51e67dffaa8d3afdeed66e5 Mon Sep 17 00:00:00 2001 From: Connor Burton Date: Sun, 17 Sep 2023 12:38:12 +0000 Subject: [PATCH 2/2] chore(docs): automated update typedocs after release [skip ci] --- docs/classes/AuthError.html | 12 ++++++------ docs/functions/HMAC.html | 2 +- docs/functions/generate.html | 2 +- docs/functions/order-1.html | 2 +- docs/index.html | 1 - docs/interfaces/GenerateOptions.html | 4 ++-- docs/interfaces/Options.html | 14 +++++++------- docs/types/DynamicSecret.html | 2 +- docs/types/Order.html | 2 +- docs/types/UnknownObject.html | 2 +- docs/variables/defaults.html | 2 +- 11 files changed, 22 insertions(+), 23 deletions(-) diff --git a/docs/classes/AuthError.html b/docs/classes/AuthError.html index 26537bf..8d24689 100644 --- a/docs/classes/AuthError.html +++ b/docs/classes/AuthError.html @@ -22,7 +22,7 @@

Hierarchy

+
  • Defined in src/errors.ts:1
    • @@ -64,7 +64,7 @@
    message: Returns AuthError
    +
  • Defined in src/errors.ts:7

    • Properties

    @@ -77,7 +77,7 @@

    Optionalcode

    code: string
    +
  • Defined in src/errors.ts:2

    • message

    message: string
    +
  • Defined in src/errors.ts:3

    • statusCode

    statusCode: number
    +
  • Defined in src/errors.ts:4

    • status_code

    status_code: number
    +
  • Defined in src/errors.ts:5

    • Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)
    diff --git a/docs/functions/HMAC.html b/docs/functions/HMAC.html index 5ed8222..950b813 100644 --- a/docs/functions/HMAC.html +++ b/docs/functions/HMAC.html @@ -28,7 +28,7 @@
    secret: options: Partial<Options> = {}

    Returns RequestHandler

    +
  • Defined in src/index.ts:80
    • diff --git a/docs/functions/generate.html b/docs/functions/generate.html index 362092f..03c5a00 100644 --- a/docs/functions/generate.html +++ b/docs/functions/generate.html @@ -38,7 +38,7 @@
    Optional Optional options: GenerateOptions

    Returns Hmac

    +
  • Defined in src/generate.ts:27
    • diff --git a/docs/functions/order-1.html b/docs/functions/order-1.html index cc32061..7f82bda 100644 --- a/docs/functions/order-1.html +++ b/docs/functions/order-1.html @@ -26,7 +26,7 @@

    Parameters

    o: UnknownObject

    Returns UnknownObject

    +
  • Defined in src/order.ts:3
    • diff --git a/docs/index.html b/docs/index.html index dc787d9..f34004f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,7 +13,6 @@

    hmac-auth-express

    HMAC Auth Express

    npm -GitHub Workflow Status GitHub

    This package provides Express middleware for HMAC authentication.

      diff --git a/docs/interfaces/GenerateOptions.html b/docs/interfaces/GenerateOptions.html index 1ce99b8..90e8469 100644 --- a/docs/interfaces/GenerateOptions.html +++ b/docs/interfaces/GenerateOptions.html @@ -20,7 +20,7 @@

      Hierarchy

      • GenerateOptions
      +
    • Defined in src/generate.ts:4
    @@ -36,7 +36,7 @@

    Properties

    Optional order

    order?: Order
    +
  • Defined in src/generate.ts:5
    • diff --git a/docs/interfaces/Options.html b/docs/interfaces/Options.html index 5226c2b..fdef64f 100644 --- a/docs/interfaces/Options.html +++ b/docs/interfaces/Options.html @@ -20,7 +20,7 @@

    Hierarchy

    • Options
    +
  • Defined in src/index.ts:24
    • @@ -45,7 +45,7 @@

    algorithm

    +
  • Defined in src/index.ts:30

    • header

    header: string
    @@ -54,7 +54,7 @@

    header

    +
  • Defined in src/index.ts:42

    • identifier

    identifier: string
    @@ -63,7 +63,7 @@

    identifier

    +
  • Defined in src/index.ts:36

    • maxInterval

    maxInterval: number
    @@ -74,7 +74,7 @@

    maxInterval

    +
  • Defined in src/index.ts:50

    • minInterval

    minInterval: number
    @@ -85,7 +85,7 @@

    minInterval

    +
  • Defined in src/index.ts:58

    • Optional order

    order?: Order
    @@ -93,7 +93,7 @@

    Optional

    +
  • Defined in src/index.ts:62
    • diff --git a/docs/types/DynamicSecret.html b/docs/types/DynamicSecret.html index ccf77b1..23d85d6 100644 --- a/docs/types/DynamicSecret.html +++ b/docs/types/DynamicSecret.html @@ -47,7 +47,7 @@
    req: Returns Promise<string | undefined>
    +
  • Defined in src/index.ts:18
    • diff --git a/docs/types/Order.html b/docs/types/Order.html index cbea61c..835e96a 100644 --- a/docs/types/Order.html +++ b/docs/types/Order.html @@ -30,7 +30,7 @@

    Parameters

    o: UnknownObject

    Returns UnknownObject

    +
  • Defined in src/index.ts:22
    • diff --git a/docs/types/UnknownObject.html b/docs/types/UnknownObject.html index 8cc27d0..c124dec 100644 --- a/docs/types/UnknownObject.html +++ b/docs/types/UnknownObject.html @@ -17,7 +17,7 @@

    Type alias UnknownObject

    UnknownObject: Record<string, unknown>
    +
  • Defined in src/index.ts:12
    • diff --git a/docs/variables/defaults.html b/docs/variables/defaults.html index aea21bf..22034b8 100644 --- a/docs/variables/defaults.html +++ b/docs/variables/defaults.html @@ -17,7 +17,7 @@

    Variable defaultsConst

    defaults: Options = ...
    +
  • Defined in src/index.ts:65