Class BanSmall

Represents a Ban on iFunny

Hierarchy

Constructors

Properties

#client: Client<boolean>

Client instance attached to the Object

#endpointUrl: string = Endpoints.account

Endpoint url the object will request to

#payload: APIBanSmall

The payload of the object.

#user: User

User the Ban belongs to

Accessors

  • get endpointUrl(): string
  • Endpoint url for requests to update the payload

    Returns string

  • set endpointUrl(value: string): void
  • Parameters

    • value: string

    Returns void

  • get payload(): Payload
  • Get the payload of the object

    Returns Payload

  • set payload(payload: Partial<Payload>): void
  • Updates the payload of the object.

    Returns

    The current instance

    Parameters

    • payload: Partial<Payload>

      The payload to merge into the current instance

    Returns void

  • get type(): "chat_access" | "comment_creation" | "content_creation" | "profile_access" | "repubing" | "smiling" | "subscribing" | "other" | "collective_shadow"
  • The type of the ban

    Returns "chat_access" | "comment_creation" | "content_creation" | "profile_access" | "repubing" | "smiling" | "subscribing" | "other" | "collective_shadow"

Methods

  • Gets the value from the payload from its key

    Returns

    Type Parameters

    • P extends APIBanSmall

    • K extends string | number | symbol

    Parameters

    • key: K

      The key to get the value of

    Returns Nullify<P[K]>

Generated using TypeDoc