Separator
Extends
Constructors
Constructor
new Separator(
options):Separator
Parameters
| Parameter | Type |
|---|---|
options | { divider: boolean; spacing: 2 | 1 | "small" | "large"; } |
options.divider? | boolean |
options.spacing? | 2 | 1 | "small" | "large" |
Returns
Separator
Overrides
Properties
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
|---|---|---|---|---|---|---|
divider | public | boolean | true | Whether a visual divider should be displayed in the component | - | - |
id? | public | number | undefined | 32 bit integer used as an optional identifier for component The id field is optional and is used to identify components in the response from an interaction that aren't interactive components. The id must be unique within the message and is generated sequentially by Discord if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component. | - | BaseComponent.id |
isV2 | readonly | true | true | Whether the component is a v2 component and requires the IS_COMPONENTS_V2 flag | BaseComponent.isV2 | - |
spacing | public | 2 | 1 | "small" | "large" | "small" | The size of the separator's padding Either "small" or "large" Default "small" | - | - |
type | readonly | Separator | undefined | The type of the component | BaseComponent.type | - |
Methods
serialize()
serialize():
APISeparatorComponent
Returns
APISeparatorComponent
Overrides
BaseComponent.serialize