Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions .pkgs/configs/typedoc.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,38 @@
"$schema": "https://typedoc.org/schema.json",
"cleanOutputDir": true,
"disableSources": true,
"hideGenerator": true,
"entryPoints": [
"src/index.ts"
],
"excludeInternal": true,
"expandObjects": true,
"expandParameters": true,
"hideGenerator": true,
"hidePageHeader": true,
"hidePageTitle": false,
"indexFormat": "table",
"parametersFormat": "table",
"interfacePropertiesFormat": "table",
"classPropertiesFormat": "table",
"typeAliasPropertiesFormat": "table",
"enumMembersFormat": "table",
"propertyMembersFormat": "table",
"typeDeclarationFormat": "table",
"jsDocCompatibility": true,
"logLevel": "Warn",
"name": "Public APIs",
"out": "docs",
"plugin": [
"typedoc-plugin-markdown",
"typedoc-plugin-mdn-links"
],
"readme": "none",
"sort": [
"kind",
"instance-first",
"alphabetical"
],
"plugin": [
"typedoc-plugin-markdown",
"typedoc-plugin-mdn-links"
],
"theme": "default",
"useCodeBlocks": true,
"useTsLinkResolution": true
}
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
[**@eslint-react/core**](../../../README.md)

***

[@eslint-react/core](../../../README.md) / isReactAPI

# isReactAPI

## Type Aliases

- [ReturnType](type-aliases/ReturnType.md)
| Type Alias | Description |
| ------ | ------ |
| [ReturnType](type-aliases/ReturnType.md) | - |
Original file line number Diff line number Diff line change
@@ -1,50 +1,54 @@
[**@eslint-react/core**](../../../../README.md)

***

[@eslint-react/core](../../../../README.md) / [isReactAPI](../README.md) / ReturnType

# Type Alias: ReturnType()

> **ReturnType** = \{(`context`, `node`): node is Identifier \| MemberExpression; (`context`): (`node`) => node is Identifier \| MemberExpression; \}
```ts
type ReturnType = {
(context: RuleContext, node: Node | null | undefined): node is Identifier | MemberExpression;
(context: RuleContext): (node: Node | null | undefined) => node is Identifier | MemberExpression;
};
```

## Call Signature

> (`context`, `node`): node is Identifier \| MemberExpression
```ts
(context: RuleContext, node: Node | null | undefined): node is Identifier | MemberExpression;
```

### Parameters

#### context

`RuleContext`

#### node

`Node` | `null` | `undefined`
| Parameter | Type |
| ------ | ------ |
| `context` | `RuleContext` |
| `node` | `Node` \| `null` \| `undefined` |

### Returns

node is Identifier \| MemberExpression

## Call Signature

> (`context`): (`node`) => node is Identifier \| MemberExpression
```ts
(context: RuleContext): (node: Node | null | undefined) => node is Identifier | MemberExpression;
```

### Parameters

#### context

`RuleContext`
| Parameter | Type |
| ------ | ------ |
| `context` | `RuleContext` |

### Returns

> (`node`): node is Identifier \| MemberExpression
```ts
(node: Node | null | undefined): node is Identifier | MemberExpression;
```

#### Parameters

##### node

`Node` | `null` | `undefined`
| Parameter | Type |
| ------ | ------ |
| `node` | `Node` \| `null` \| `undefined` |

#### Returns

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
[**@eslint-react/core**](../../../README.md)

***

[@eslint-react/core](../../../README.md) / isReactAPICall

# isReactAPICall

## Type Aliases

- [ReturnType](type-aliases/ReturnType.md)
| Type Alias | Description |
| ------ | ------ |
| [ReturnType](type-aliases/ReturnType.md) | - |
Original file line number Diff line number Diff line change
@@ -1,50 +1,54 @@
[**@eslint-react/core**](../../../../README.md)

***

[@eslint-react/core](../../../../README.md) / [isReactAPICall](../README.md) / ReturnType

# Type Alias: ReturnType()

> **ReturnType** = \{(`context`, `node`): `node is CallExpression`; (`context`): (`node`) => `node is CallExpression`; \}
```ts
type ReturnType = {
(context: RuleContext, node: Node | null | undefined): node is CallExpression;
(context: RuleContext): (node: Node | null | undefined) => node is CallExpression;
};
```

## Call Signature

> (`context`, `node`): `node is CallExpression`
```ts
(context: RuleContext, node: Node | null | undefined): node is CallExpression;
```

### Parameters

#### context

`RuleContext`

#### node

`Node` | `null` | `undefined`
| Parameter | Type |
| ------ | ------ |
| `context` | `RuleContext` |
| `node` | `Node` \| `null` \| `undefined` |

### Returns

`node is CallExpression`

## Call Signature

> (`context`): (`node`) => `node is CallExpression`
```ts
(context: RuleContext): (node: Node | null | undefined) => node is CallExpression;
```

### Parameters

#### context

`RuleContext`
| Parameter | Type |
| ------ | ------ |
| `context` | `RuleContext` |

### Returns

> (`node`): `node is CallExpression`
```ts
(node: Node | null | undefined): node is CallExpression;
```

#### Parameters

##### node

`Node` | `null` | `undefined`
| Parameter | Type |
| ------ | ------ |
| `node` | `Node` \| `null` \| `undefined` |

#### Returns

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
[**@eslint-react/core**](../../../README.md)

***

[@eslint-react/core](../../../README.md) / useComponentCollector

# useComponentCollector

## Type Aliases

- [Options](type-aliases/Options.md)
- [ReturnType](type-aliases/ReturnType.md)
| Type Alias | Description |
| ------ | ------ |
| [Options](type-aliases/Options.md) | - |
| [ReturnType](type-aliases/ReturnType.md) | - |
Original file line number Diff line number Diff line change
@@ -1,27 +1,19 @@
[**@eslint-react/core**](../../../../README.md)

***

[@eslint-react/core](../../../../README.md) / [useComponentCollector](../README.md) / Options

# Type Alias: Options

> **Options** = `object`
```ts
type Options = {
collectDisplayName?: boolean;
collectHookCalls?: boolean;
hint?: ComponentDetectionHint;
};
```

## Properties

### collectDisplayName?

> `optional` **collectDisplayName**: `boolean`

***

### collectHookCalls?

> `optional` **collectHookCalls**: `boolean`

***

### hint?

> `optional` **hint**: [`ComponentDetectionHint`](../../../../type-aliases/ComponentDetectionHint.md)
| Property | Type |
| ------ | ------ |
| <a id="collectdisplayname"></a> `collectDisplayName?` | `boolean` |
| <a id="collecthookcalls"></a> `collectHookCalls?` | `boolean` |
| <a id="hint"></a> `hint?` | [`ComponentDetectionHint`](../../../../type-aliases/ComponentDetectionHint.md) |
Original file line number Diff line number Diff line change
@@ -1,51 +1,24 @@
[**@eslint-react/core**](../../../../README.md)

***

[@eslint-react/core](../../../../README.md) / [useComponentCollector](../README.md) / ReturnType

# Type Alias: ReturnType

> **ReturnType** = `object`
```ts
type ReturnType = {
ctx: {
getAllComponents: (node: TSESTree.Program) => Map<string, FunctionComponent>;
getCurrentEntries: () => FunctionEntry[];
getCurrentEntry: () => FunctionEntry | unit;
};
listeners: ESLintUtils.RuleListener;
};
```

## Properties

### ctx

> **ctx**: `object`

#### getAllComponents()

> **getAllComponents**: (`node`) => [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, [`FunctionComponent`](../../../../interfaces/FunctionComponent.md)\>

##### Parameters

###### node

`TSESTree.Program`

##### Returns

[`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, [`FunctionComponent`](../../../../interfaces/FunctionComponent.md)\>

#### getCurrentEntries()

> **getCurrentEntries**: () => `FunctionEntry`[]

##### Returns

`FunctionEntry`[]

#### getCurrentEntry()

> **getCurrentEntry**: () => `FunctionEntry` \| `unit`

##### Returns

`FunctionEntry` \| `unit`

***

### listeners

> **listeners**: `ESLintUtils.RuleListener`
| Property | Type |
| ------ | ------ |
| <a id="ctx"></a> `ctx` | \{ `getAllComponents`: (`node`: `TSESTree.Program`) => [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, [`FunctionComponent`](../../../../interfaces/FunctionComponent.md)\>; `getCurrentEntries`: () => `FunctionEntry`[]; `getCurrentEntry`: () => `FunctionEntry` \| `unit`; \} |
| `ctx.getAllComponents` | (`node`: `TSESTree.Program`) => [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)\<`string`, [`FunctionComponent`](../../../../interfaces/FunctionComponent.md)\> |
| `ctx.getCurrentEntries` | () => `FunctionEntry`[] |
| `ctx.getCurrentEntry` | () => `FunctionEntry` \| `unit` |
| <a id="listeners"></a> `listeners` | `ESLintUtils.RuleListener` |
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
[**@eslint-react/core**](../../../README.md)

***

[@eslint-react/core](../../../README.md) / useComponentCollectorLegacy

# useComponentCollectorLegacy

## Type Aliases

- [ReturnType](type-aliases/ReturnType.md)
| Type Alias | Description |
| ------ | ------ |
| [ReturnType](type-aliases/ReturnType.md) | - |
Loading
Loading