Sign upLogin

Odi-ts/odi

View on GitHub
Star
src/auth/auth.types.ts

Summary

Maintainability
A
0 mins
Test Coverage

jsdoc is not formatted correctly on this line
Open

        *@member {string} - Max age of token
Severity: Minor
Found in src/auth/auth.types.ts by tslint

Rule: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

  • each line contains an asterisk and asterisks must be aligned
  • each asterisk must be followed by either a space or a newline (except for the first and the last)
  • the only characters before the asterisk on each line must be whitespace characters
  • one line comments must start with /** and end with */
  • multiline comments don't allow text after /** in the first line (with option "check-multiline-start")
Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

For more information see this page.

'namespace' and 'module' are disallowed
Open

export namespace JWT {
    export interface SignOptions {
        /**
         * Signature algorithm. Could be one of these values :
         * - HS256:    HMAC using SHA-256 hash algorithm (default)
Severity: Minor
Found in src/auth/auth.types.ts by tslint

Rule: no-namespace

Disallows use of internal modules and namespaces.

This rule still allows the use of declare module ... {}

Rationale

ES6-style external modules are the standard way to modularize code. Using module {} and namespace {} are outdated ways to organize TypeScript code.

Notes
  • TypeScript Only

Config

One argument may be optionally provided:

  • allow-declarations allows declare namespace ... {} to describe external APIs.
Examples
"no-namespace": true
"no-namespace": true,allow-declarations
Schema
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-declarations"
    ]
  },
  "minLength": 0,
  "maxLength": 1
}

For more information see this page.

jsdoc is not formatted correctly on this line
Open

         *@deprecated
Severity: Minor
Found in src/auth/auth.types.ts by tslint

Rule: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

  • each line contains an asterisk and asterisks must be aligned
  • each asterisk must be followed by either a space or a newline (except for the first and the last)
  • the only characters before the asterisk on each line must be whitespace characters
  • one line comments must start with /** and end with */
  • multiline comments don't allow text after /** in the first line (with option "check-multiline-start")
Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

For more information see this page.

asterisks in jsdoc must be aligned
Open

        *@member {string} - Max age of token
Severity: Minor
Found in src/auth/auth.types.ts by tslint

Rule: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

  • each line contains an asterisk and asterisks must be aligned
  • each asterisk must be followed by either a space or a newline (except for the first and the last)
  • the only characters before the asterisk on each line must be whitespace characters
  • one line comments must start with /** and end with */
  • multiline comments don't allow text after /** in the first line (with option "check-multiline-start")
Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

For more information see this page.

asterisks in jsdoc must be aligned
Open

        */
Severity: Minor
Found in src/auth/auth.types.ts by tslint

Rule: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

  • each line contains an asterisk and asterisks must be aligned
  • each asterisk must be followed by either a space or a newline (except for the first and the last)
  • the only characters before the asterisk on each line must be whitespace characters
  • one line comments must start with /** and end with */
  • multiline comments don't allow text after /** in the first line (with option "check-multiline-start")
Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples
"jsdoc-format": true
"jsdoc-format": true,check-multiline-start
Schema
{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

For more information see this page.

There are no issues that match your filters.

Category
Status