Microsoft/TypeScript

Docs of `charCodeAt` and `codePointAt` are flipped

Open

#49.561 aberto em 15 de jun. de 2022

Ver no GitHub
 (8 comments) (0 reactions) (0 assignees)TypeScript (6.726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Métricas do repositório

Stars
 (48.455 stars)
Métricas de merge de PR
 (Mesclagem média 6d 17h) (9 fundiu PRs em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
O problema relata que as descrições JSDoc para `String.prototype.charCodeAt` e `String.prototype.codePointAt` estão trocadas. Para corrigir, localize o arquivo lib.es5.d.ts (para charCodeAt) e lib.es2015.core.d.ts (para codePointAt) no repositório TypeScript. Troque as descrições para que `codePointAt` seja descrito como retornando o ponto de código Unicode e `charCodeAt` como retornando a unidade de código UTF 16. Siga a documentação MDN vinculada na issue para o texto correto.
Pilha de tecnologia
typescript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
95