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

feat: link basic types to MDN/TS documentation (#9913)

Browse Source 
* feat: link basic types to MDN/TS documentation

* refactor: requested changes
This commit is contained in:
Almeida
2023-11-10 14:50:25 +00:00
committed by GitHub
parent 6dca8013af
commit 81334a2a2c
3 changed files with 98 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
apps/website/src/util/builtinDocumentationLinks.ts Normal file
View File

@@ -0,0 +1,76 @@
export const BuiltinDocumentationLinks = {
// Built-in types
bigint: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/BigInt',
boolean: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean',
null: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/null',
number: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number',
string: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String',
symbol: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol',
undefined: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined',
// Built-in classes
Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array',
ArrayBuffer: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer',
AsyncGenerator: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator',
AsyncIterable: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Iteration_protocols',
AsyncIterableIterator: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Iteration_protocols',
Buffer: 'https://nodejs.org/api/buffer.html#class-buffer',
Date: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date',
Error: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error',
Function: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function',
Generator: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Generator',
Iterable: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Iteration_protocols',
IterableIterator: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Iteration_protocols',
Iterator: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Iterator',
Map: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map',
Promise: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise',
RegExp: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp',
Set: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set',
WeakMap: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap',
WeakRef: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakRef',
WeakSet: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakSet',
// Typed arrays
BigInt64Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/BigInt64Array',
BigUint64Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/BigUint64Array',
Float32Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Float32Array',
Float64Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Float64Array',
Int16Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int16Array',
Int32Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int32Array',
Int8Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int8Array',
Uint16Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array',
Uint32Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array',
Uint8Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array',
Uint8ClampedArray: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray',
// TypeScript types
any: 'https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any',
never: 'https://www.typescriptlang.org/docs/handbook/2/functions.html#never',
object: 'https://www.typescriptlang.org/docs/handbook/2/functions.html#object',
ReadonlyArray: 'https://www.typescriptlang.org/docs/handbook/2/objects.html#the-readonlyarray-type',
unknown: 'https://www.typescriptlang.org/docs/handbook/2/functions.html#unknown',
void: 'https://www.typescriptlang.org/docs/handbook/2/functions.html#void',
// TypeScript utility types
Awaited: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#awaitedtype',
Partial: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype',
Required: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype',
Readonly: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype',
Record: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type',
Pick: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys',
Omit: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys',
Exclude: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#excludeuniontype-excludedmembers',
Extract: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#extracttype-union',
NonNullable: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#nonnullabletype',
Parameters: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#parameterstype',
ConstructorParameters: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#constructorparameterstype',
ReturnType: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#returntypetype',
InstanceType: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#instancetypetype',
ThisParameterType: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#thisparametertypetype',
OmitThisParameter: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#omitthisparametertype',
ThisType: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#thistypetype',
Uppercase: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#uppercasestringtype',
Lowercase: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#lowercasestringtype',
Capitalize: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#capitalizestringtype',
Uncapitalize: 'https://www.typescriptlang.org/docs/handbook/utility-types.html#uncapitalizestringtype',
} as const;