Microsoft/TypeScript

Docs of `charCodeAt` and `codePointAt` are flipped

Aperta

#49.561 aperta il 15 giu 2022

Vedi su GitHubGuida contributor
 (8 commenti) (0 reazioni) (0 assegnatari)TypeScript (13.395 fork)batch import
BugDomain: lib.d.tsHelp Wanted

Metriche repository

Star
 (108.860 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Bug Report

Docs of charCodeAt and codePointAt are flipped. Described in MDN, the codePointAt returns Unicode code point, and charCodeAt returns UTF16 char code, however in JSDoc string of Typescript they are flipped.

How it is

https://github.com/microsoft/TypeScript/blob/89d05f7131b233c4482aaba5c15ad289f26173b4/lib/lib.es2015.core.d.ts#L401-L408

https://github.com/microsoft/TypeScript/blob/89d05f7131b233c4482aaba5c15ad289f26173b4/lib/lib.es5.d.ts#L404-L408

How it should be

The codePointAt() method returns a non-negative integer that is the Unicode code point value at the given position. Note that this function does not give the nth code point in a string, but the code point starting at the specified string index. Docs

The charCodeAt() method returns an integer between 0 and 65535 representing the UTF-16 code unit at the given index. Docs

Guida contributor

Direzione di ricerca
Il problema segnala che le descrizioni JSDoc per `String.prototype.charCodeAt` e `String.prototype.codePointAt` sono scambiate. Per risolvere, individuare il file lib.es5.d.ts (per charCodeAt) e lib.es2015.core.d.ts (per codePointAt) nel repository TypeScript. Scambiare le descrizioni in modo che `codePointAt` sia descritto come restituente il punto di codice Unicode e `charCodeAt` come restituente l'unità di codice UTF 16. Seguire la documentazione MDN collegata nell'issue per il testo corretto.
Tech stack
typescript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
95