daenamnu/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-06-04 18:10:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add website documentation early mvp (#8183)

Browse Source 
Co-authored-by: iCrawl <buechler.noel@outlook.com>
This commit is contained in:
Suneet Tipirneni
2022-07-01 14:54:15 -04:00
committed by GitHub
parent e0c8282490
commit d95197cc78
41 changed files with 1800 additions and 647 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
packages/website/src/DocModel/DocFunction.ts Normal file
View File

@@ -0,0 +1,25 @@
import type { ApiFunction, ApiModel } from '@microsoft/api-extractor-model';
import { DocItem } from './DocItem';
import { type ParameterDocumentation, type TokenDocumentation, genParameter, genToken } from '~/util/parse.server';
export class DocFunction extends DocItem<ApiFunction> {
public readonly parameters: ParameterDocumentation[];
public readonly returnTypeTokens: TokenDocumentation[];
public readonly overloadIndex: number;
public constructor(model: ApiModel, item: ApiFunction) {
super(model, item);
this.parameters = item.parameters.map((param) => genParameter(this.model, param));
this.returnTypeTokens = item.returnTypeExcerpt.spannedTokens.map((token) => genToken(this.model, token));
this.overloadIndex = item.overloadIndex;
}
public override toJSON() {
return {
...super.toJSON(),
parameters: this.parameters,
returnTypeTokens: this.returnTypeTokens,
overloadIndex: this.overloadIndex,
};
}
}