Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-16 03:23:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(structures): add Team structure (#11396)

Browse Source 
* feat(structures): add and update barrel exports in prep for new struct

* feat(structures): add TeamMember substructure

* feat(structures): add Team structure

* chore(structures): add ownerUserId attribute back

* chore(structures): add teamId attribute

* docs(structures): correctly use see/link blocks and cleanup

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Asad
2026-01-27 22:59:42 +00:00
committed by GitHub
parent fc5ba6be70
commit c126367140
4 changed files with 121 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
packages/structures/src/teams/TeamMember.ts Normal file
View File

@@ -0,0 +1,49 @@
import type { APITeamMember } from 'discord-api-types/v10';
import { Structure } from '../Structure.js';
import { kData } from '../utils/symbols.js';
import type { Partialize } from '../utils/types.js';
/**
* Represents any team member on Discord.
*
* @typeParam Omitted - Specify the properties that will not be stored in the raw data field as a union, implement via `DataTemplate`
* @remarks has substructure `User` which needs to be instantiated and stored by an extending class using it
*/
export class TeamMember<Omitted extends keyof APITeamMember | '' = ''> extends Structure<APITeamMember, Omitted> {
/**
* The template used for removing data from the raw data stored for each team member
*/
public static override readonly DataTemplate: Partial<APITeamMember> = {};
/**
* @param data - The raw data received from the API for the team member
*/
public constructor(data: Partialize<APITeamMember, Omitted>) {
super(data);
}
/**
* User's membership state on the team
*
* @see {@link https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum}
*/
public get membershipState() {
return this[kData].membership_state;
}
/**
* Id of the parent team of which they are a member
*/
public get teamId() {
return this[kData].team_id;
}
/**
* Role of the team member
*
* @see {@link https://discord.com/developers/docs/topics/teams#team-member-roles-team-member-role-types}
*/
public get role() {
return this[kData].role;
}
}