Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update typedoc MD plugin to 4.x #875

Closed
wants to merge 5 commits into from
Closed
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
4,586 changes: 4,586 additions & 0 deletions docs/matter-node-ble.js/-internal-/README.md

Large diffs are not rendered by default.

300 changes: 300 additions & 0 deletions docs/matter-node-ble.js/-internal-/classes/AttributeClient.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,300 @@
[**@project-chip/matter-node-ble.js**](../../README.md) • **Docs**

***

[@project-chip/matter-node-ble.js](../../globals.md) / [\<internal\>](../README.md) / AttributeClient

# Class: AttributeClient\<T\>

General class for AttributeClients

## Type parameters

| Type parameter |
| :------ |
| `T` |

## Constructors

### new AttributeClient()

> **new AttributeClient**\<`T`\>(`attribute`, `name`, `endpointId`, `clusterId`, `interactionClient`): [`AttributeClient`](AttributeClient.md)\<`T`\>

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `attribute` | [`Attribute`](../interfaces/Attribute.md)\<`T`, `any`\> |
| `name` | `string` |
| `endpointId` | [`EndpointNumber`](../README.md#endpointnumber) |
| `clusterId` | [`ClusterId`](../README.md#clusterid) |
| `interactionClient` | [`InteractionClient`](InteractionClient.md) |

#### Returns

[`AttributeClient`](AttributeClient.md)\<`T`\>

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:30

## Properties

### attribute

> `readonly` **attribute**: [`Attribute`](../interfaces/Attribute.md)\<`T`, `any`\>

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:20

***

### clusterId

> `readonly` **clusterId**: [`ClusterId`](../README.md#clusterid)

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:23

***

### endpointId

> `readonly` **endpointId**: [`EndpointNumber`](../README.md#endpointnumber)

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:22

***

### id

> `readonly` **id**: [`AttributeId`](../README.md#attributeid)

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:29

***

### interactionClient

> `private` `readonly` **interactionClient**: `any`

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:24

***

### isFabricScoped

> `private` `readonly` **isFabricScoped**: `any`

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:26

***

### isWritable

> `private` `readonly` **isWritable**: `any`

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:25

***

### listeners

> `private` `readonly` **listeners**: `any`

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:28

***

### name

> `readonly` **name**: `string`

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:21

***

### schema

> `protected` `readonly` **schema**: [`TlvSchema`](TlvSchema.md)\<`any`\>

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:27

## Methods

### addListener()

> **addListener**(`listener`): `void`

Add a listener to the attribute.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `listener` | (`newValue`) => `void` |

#### Returns

`void`

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:53

***

### get()

> **get**(`alwaysRequestFromRemote`?, `isFabricFiltered`?): `Promise`\<`undefined` \| `T`\>

Get the value of the attribute. Fabric scoped reads are always done with the remote.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `alwaysRequestFromRemote`? | `boolean` |
| `isFabricFiltered`? | `boolean` |

#### Returns

`Promise`\<`undefined` \| `T`\>

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:37

***

### getWithVersion()

> **getWithVersion**(`alwaysRequestFromRemote`?, `isFabricFiltered`?): `Promise`\<`undefined` \| `object`\>

Get the value with version of the attribute. Fabric scoped reads are always done with the remote.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `alwaysRequestFromRemote`? | `boolean` |
| `isFabricFiltered`? | `boolean` |

#### Returns

`Promise`\<`undefined` \| `object`\>

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:41

***

### removeListener()

> **removeListener**(`listener`): `void`

Remove a listener from the attribute.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `listener` | (`newValue`) => `void` |

#### Returns

`void`

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:55

***

### set()

> **set**(`value`, `dataVersion`?): `Promise`\<`void`\>

Set the value of the attribute. When dataVersion parameter is provided the value is only set when the
cluster dataVersion of the server matches. If it does not match it is rejected with an Error.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `value` | `T` |
| `dataVersion`? | `number` |

#### Returns

`Promise`\<`void`\>

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:35

***

### subscribe()

> **subscribe**(`minIntervalFloorSeconds`, `maxIntervalCeilingSeconds`, `knownDataVersion`?, `isFabricFiltered`?): `Promise`\<`void`\>

Subscribe to the attribute.

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `minIntervalFloorSeconds` | `number` |
| `maxIntervalCeilingSeconds` | `number` |
| `knownDataVersion`? | `number` |
| `isFabricFiltered`? | `boolean` |

#### Returns

`Promise`\<`void`\>

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:46

***

### update()

> `private` **update**(`value`): `void`

Update the value of the attribute. Just internally used!

#### Parameters

| Parameter | Type |
| :------ | :------ |
| `value` | `T` |

#### Returns

`void`

#### Source

matter.js/dist/esm/cluster/client/AttributeClient.d.ts:51
Loading