@lands.io/mod-sdk / ClanInfo

Interface: ClanInfo¶

Basic clan information returned by batch and search endpoints

Hierarchy¶

ClanInfo

↳ ClanDetails

Table of contents¶

Properties¶

createdAt¶

• createdAt: Date

Creation timestamp

description¶

• Optional description: string

Optional description

discord¶

• Optional discord: string

Optional Discord invite link

id¶

• id: string

Unique clan ID

joinType¶

• joinType: string

Join type: 'open', 'approval', 'invite'

level¶

• level: number

Clan level

memberCount¶

• memberCount: number

Number of members

name¶

• name: string

Clan name

tag¶

• tag: string

Clan tag (max 6 characters)

Source Code¶

View full implementation

/**
 * Basic clan information returned by batch and search endpoints
 */
export interface ClanInfo {
  /** Unique clan ID */
  id: string;
  /** Clan tag (max 6 characters) */
  tag: string;
  /** Clan name */
  name: string;
  /** Number of members */
  memberCount: number;
  /** Clan level */
  level: number;
  /** Join type: 'open', 'approval', 'invite' */
  joinType: string;
  /** Creation timestamp */
  createdAt: Date;
  /** Optional description */
  description?: string;
  /** Optional Discord invite link */
  discord?: string;
}