---
url: /reference/@cssdoc/cssdoc/variables/customProperty.md
---
# Variable: customProperty

```ts
const customProperty: object;
```

Defined in: [packages/providers/src/aspects.ts:1328](https://github.com/thedannywahl/cssdoc/blob/main/packages/providers/src/aspects.ts#L1328)

## Type Declaration

### assignment()

```ts
assignment(a, index): Diagnostic[];
```

Consumer-side: an assignment `--name: value` must match the property's declared syntax.

#### Parameters

##### a

[`PropertyAssignment`](../../index/interfaces/PropertyAssignment.md)

##### index

[`CssDocIndex`](../../index/classes/CssDocIndex.md)

#### Returns

[`Diagnostic`](../interfaces/Diagnostic.md)\[]

### completions()

```ts
completions(index): Completion[];
```

#### Parameters

##### index

[`CssDocIndex`](../../index/classes/CssDocIndex.md)

#### Returns

[`Completion`](../interfaces/Completion.md)\[]

### definition()

```ts
definition(name, index): Location | undefined;
```

#### Parameters

##### name

`string`

##### index

[`CssDocIndex`](../../index/classes/CssDocIndex.md)

#### Returns

[`Location`](../../index/interfaces/Location.md) | `undefined`

### hover()

```ts
hover(
   name, 
   index, 
   valueIndex?
): Hover | undefined;
```

#### Parameters

##### name

`string`

##### index

[`CssDocIndex`](../../index/classes/CssDocIndex.md)

##### valueIndex?

[`CssDocIndex`](../../index/classes/CssDocIndex.md) = `index`

#### Returns

[`Hover`](../interfaces/Hover.md) | `undefined`

### model()

```ts
model(index): Diagnostic[];
```

Author-side: a registered property's default (`initial-value`/`@defaultValue`) must match its syntax.

#### Parameters

##### index

[`CssDocIndex`](../../index/classes/CssDocIndex.md)

#### Returns

[`Diagnostic`](../interfaces/Diagnostic.md)\[]

### propertyUsage()

```ts
propertyUsage(
   usage, 
   index, 
   options
): Diagnostic[];
```

#### Parameters

##### usage

[`PropertyUsage`](../../index/interfaces/PropertyUsage.md)

##### index

[`CssDocIndex`](../../index/classes/CssDocIndex.md)

##### options

[`UsageOptions`](../interfaces/UsageOptions.md)

#### Returns

[`Diagnostic`](../interfaces/Diagnostic.md)\[]
