Class StrikeEntity

Represents a Strike (warning/infraction) issued to a user.

Index

Constructors

Properties

active id reason staffer strikedAt unstrikedAt unstrikedBy unstrikeReason userId

Methods

Constructors

constructor

new StrikeEntity(client: RankedClient, data: Strike): StrikeEntity
Instantiates a new StrikeEntity.
Parameters
- client: RankedClient
  The active SDK client instance.
- data: Strike
  The raw strike data from the API.
Returns StrikeEntity
- Defined in packages/sdk/src/managers/punishments/entities/strike.entity.ts:33

Properties

active

active: boolean

See

id

id: number

See

reason

reason: string | null

See

staffer

staffer: string | null

See

strikedAt

strikedAt: Date

See

Strike.strikedAt

unstrikedAt

unstrikedAt: Date | null

See

Strike.unstrikedAt

unstrikedBy

unstrikedBy: string | null

See

Strike.unstrikedBy

unstrikeReason

unstrikeReason: string | null

See

Strike.unstrikeReason

userId

userId: number

See

Methods

remove

remove(dto: RemoveStrikeDto): Promise<void>
Removes this strike directly.
Parameters
- dto: RemoveStrikeDto
  The removal details (staffer ID and optional reason).
Returns Promise<void>
A promise resolving when the strike is successfully removed.
- Defined in packages/sdk/src/managers/punishments/entities/strike.entity.ts:50