Variable defaultConst

Type Declaration

• helpers: {
      generateSecret(byteLength: number): string;
      normalizeSecret(secret: string): string;
  }

• validate: {
      account(account: string): void;
      algorithm(algo: string): void;
      digits(digits: number): void;
      issuer(issuer: string): void;
      period(period: number): void;
      secret(secret: string): void;
  }

• generateToken: function

  • generateToken(
        secret: Buffer,
        counter: number,
        digits: number,
        algorithm: "SHA1" | "SHA256" | "SHA512",
    ): string

    Parameters

    • secret: Buffer
    • counter: number
    • digits: number
    • algorithm: "SHA1" | "SHA256" | "SHA512"

    Returns string

• generateURI: function

  • generateURI(
        options: {
            account: string;
            algorithm?: "SHA1" | "SHA256" | "SHA512";
            byteLength?: number;
            digits?: 6 | 7 | 8;
            issuer: string;
            period?: number;
            secret?: string;
        },
    ): { secret: string; uri: string }

    Parameters

    • options: {
          account: string;
          algorithm?: "SHA1" | "SHA256" | "SHA512";
          byteLength?: number;
          digits?: 6 | 7 | 8;
          issuer: string;
          period?: number;
          secret?: string;
      }

    Returns { secret: string; uri: string }

• verifyToken: function

  • verifyToken(
        token: string,
        secret: string,
        options?: Partial<
            {
                algorithm: "SHA1"
                | "SHA256"
                | "SHA512";
                digits: 6 | 7 | 8;
                now: number;
                period: number;
                window: number;
            },
        >,
    ): boolean

    Parameters

    • token: string
    • secret: string
    • options: Partial<
          {
              algorithm: "SHA1"
              | "SHA256"
              | "SHA512";
              digits: 6 | 7 | 8;
              now: number;
              period: number;
              window: number;
          },
      > = {}

    Returns boolean