lib/instrumenter/src/types.ts
Array type using 'Array<t>' is forbidden. Use 'T[]' instead.</t> Open
Open
intercept?: boolean | ((method: string, path: Array<string | CallRef>) => boolean);
- Read upRead up
- Exclude checks
Rule: array-type
Requires using either 'T[]' or 'Array<t>' for arrays.</t>
Notes
- TypeScript Only
- Has Fix
Config
One of the following arguments must be provided:
-
"array"
enforces use ofT[]
for all types T. -
"generic"
enforces use ofArray<T>
for all types T. -
"array-simple"
enforces use ofT[]
ifT
is a simple type (primitive or type reference).
Examples
"array-type": true,array
"array-type": true,generic
"array-type": true,array-simple
Schema
{
"type": "string",
"enum": [
"array",
"generic",
"array-simple"
]
}
For more information see this page.
Don't use 'Function' as a type. Avoid using the Function
type. Prefer a specific function type, like () => void
. Open
Open
resolvers: Record<Call['id'], Function>;
- Read upRead up
- Exclude checks
Rule: ban-types
Bans specific types from being used. Does not ban the corresponding runtime objects from being used.
Notes
- TypeScript Only
Config
A list of ["regex", "optional explanation here"]
, which bans
types that match regex
Examples
"ban-types": true,Object,Use {} instead.,String
Schema
{
"type": "list",
"listType": {
"type": "array",
"items": {
"type": "string"
},
"minLength": 1,
"maxLength": 2
}
}
For more information see this page.
Array type using 'Array<t>' is forbidden. Use 'T[]' instead.</t> Open
Open
path?: Array<string | CallRef>;
- Read upRead up
- Exclude checks
Rule: array-type
Requires using either 'T[]' or 'Array<t>' for arrays.</t>
Notes
- TypeScript Only
- Has Fix
Config
One of the following arguments must be provided:
-
"array"
enforces use ofT[]
for all types T. -
"generic"
enforces use ofArray<T>
for all types T. -
"array-simple"
enforces use ofT[]
ifT
is a simple type (primitive or type reference).
Examples
"array-type": true,array
"array-type": true,generic
"array-type": true,array-simple
Schema
{
"type": "string",
"enum": [
"array",
"generic",
"array-simple"
]
}
For more information see this page.
Array type using 'Array<t>' is forbidden. Use 'T[]' instead.</t> Open
Open
path: Array<string | CallRef>;
- Read upRead up
- Exclude checks
Rule: array-type
Requires using either 'T[]' or 'Array<t>' for arrays.</t>
Notes
- TypeScript Only
- Has Fix
Config
One of the following arguments must be provided:
-
"array"
enforces use ofT[]
for all types T. -
"generic"
enforces use ofArray<T>
for all types T. -
"array-simple"
enforces use ofT[]
ifT
is a simple type (primitive or type reference).
Examples
"array-type": true,array
"array-type": true,generic
"array-type": true,array-simple
Schema
{
"type": "string",
"enum": [
"array",
"generic",
"array-simple"
]
}
For more information see this page.