Class AliasPiece

The common class for all pieces with aliases.

Hierarchy

Piece
- AliasPiece

Index

Constructors

constructor

Properties

Accessors

path
type

Methods

Constructors

constructor

new AliasPiece(store: Store<Piece>, directory: string, file: keyof string[], options?: AliasPieceOptions): AliasPiece

Overrides Piece.constructor
- Defined in src/lib/pieces/base/AliasPiece.ts:14
since

0.0.1

Parameters
- store: Store<Piece>
  
  The store this piece is for
- directory: string
  
  The base directory to the pieces folder
- file: keyof string[]
  
  The path from the pieces folder to the piece file
- Default value options: AliasPieceOptions = {}
  
  The options for this piece
Returns AliasPiece

Properties

aliases

aliases: string[]

The aliases for this piece.

since: 0.0.1

Readonly client

client: Client

The client this Piece was created with.

since: 0.0.1

Readonly directory

directory: string

The base directory this Piece is stored in.

since: 0.0.1

enabled

enabled: boolean

Whether or not the Piece is enabled.

since: 0.0.1

Readonly file

file: keyof string[]

The file location where this Piece is stored.

since: 0.0.1

name

name: string

The name of the Piece.

since: 0.0.1

Readonly store

store: Store<Piece>

The store this Piece is from.

since: 0.0.1

Accessors

path

get path(): string

Inherited from Piece.path
- Defined in src/lib/pieces/base/Piece.ts:78
The absolute path to this piece

since

0.0.1

Returns string

type

get type(): string

Inherited from Piece.type
- Defined in src/lib/pieces/base/Piece.ts:70
The type of piece this is

since

0.0.1

Returns string

Methods

disable

disable(): this

Inherited from Piece.disable
- Defined in src/lib/pieces/base/Piece.ts:110
Disables this piece

since

0.0.1

chainable

Returns this

enable

enable(): this

Inherited from Piece.enable
- Defined in src/lib/pieces/base/Piece.ts:121
Enables this piece

since

0.0.1

chainable

Returns this

init

init(): unknown

Inherited from Piece.init
- Defined in src/lib/pieces/base/Piece.ts:131
The init method to be optionally overwritten in actual pieces

since

0.0.1

Returns unknown

reload

reload(): Promise<Piece | null>

Inherited from Piece.reload
- Defined in src/lib/pieces/base/Piece.ts:87
Reloads this piece

since

0.0.1

Returns Promise<Piece | null>

The newly loaded piece

toJSON

toJSON(): Record<string, unknown>

Overrides Piece.toJSON
- Defined in src/lib/pieces/base/AliasPiece.ts:32
Defines the JSON.stringify behavior of this argument.

since

0.0.1

Returns Record<string, unknown>

toString

toString(): string

Inherited from Piece.toString
- Defined in src/lib/pieces/base/Piece.ts:141
Defines toString behavior for pieces

since

0.0.1

Returns string

This piece name

unload

unload(): boolean

Inherited from Piece.unload
- Defined in src/lib/pieces/base/Piece.ts:100
Unloads this piece

since

0.0.1

Returns boolean

Generated using TypeDoc