¿Cómo se especifica que una propiedad de clase es un número entero?


98

Estoy experimentando con TypeScript, y en el proceso de crear una clase con un campo "ID" que debería ser un número entero, me he confundido un poco.

En primer lugar, en Visual Studio 2012 con el complemento TypeScript, veo "int" en la lista de tipos de intelliSense. Pero obtengo un error de compilación que dice "el nombre 'int' no existe en el ámbito actual".

Revisé las especificaciones del idioma y solo veo los siguientes tipos primitivos: número, cadena, booleano, nulo e indefinido. Sin tipo de entero.

Entonces, me quedo con dos preguntas:

  1. ¿Cómo debo indicar a los usuarios de mi clase que un campo en particular no es solo un "número" sino un entero (y nunca un punto flotante o un número decimal)?

  2. ¿Por qué veo "int" en la lista intellisense si no es un tipo válido?

Actualización: todas las respuestas que he obtenido hasta ahora son sobre cómo JavaScript no tiene un tipo int, sería difícil imponer un tipo int en tiempo de ejecución ... Lo sé todo. Estoy preguntando si hay una forma de TypeScript de proporcionar una anotación a los usuarios de mi clase de que este campo debería ser un número entero. ¿Quizás un comentario de algún formato en particular?


6
No, y tampoco es una identificación válida en mi aplicación. 10 sería una identificación válida.
— Josh


Una forma de validar un campo y asegurarse de que solo se acepten valores enteros es crear un método de validación que primero arroje cualquier valor de entrada potencial a String, use RegEx para verificar ese valor ya sea a.) No tiene punto decimal, o b.) si existe un punto decimal, todos los caracteres siguientes son ceros. Posteriormente, el método vuelve al tipo de número y el resultado se pasa al campo que requiere la restricción.
— Nathan Toulbert

Respuestas:


100
  1. Creo que no hay una forma directa de especificar si un número es entero o de punto flotante. En la sección 3.2.1 de la especificación de TypeScript podemos ver:

    "... El tipo primitivo Número corresponde al tipo primitivo JavaScript de nombre similar y representa valores de punto flotante IEEE 754 de formato de 64 bits de doble precisión ..."

  2. Creo que intes un error en Visual Studio intelliSense. Lo correcto es number.


2
Creo que esta es la respuesta. 1) No puede especificar nada más granular que simplemente "número" para tipos numéricos, ni hay ninguna anotación reconocida para hacerlo; y 2) hay un error en el complemento VS que sugiere tipos no válidos, tal vez según la lista ECMA 262 de palabras clave reservadas (que incluye "int")
— Josh

Es posible implementar el tipo int estático, pero eligen no hacerlo. ¿Quizás piensan que es demasiado complejo de implementar?
— trusktr

28

TypeScript es un superconjunto de JavaScript, que no tiene el concepto de int. Solo tiene el concepto de número, que tiene un punto flotante.

Filosóficamente, la cantidad de trabajo que tendría que hacer el compilador para hacer cumplir solo números enteros para un tipo int de TypeScript podría ser potencialmente masiva y, en algunos casos, aún no sería posible garantizar en el tiempo de compilación que solo se asignarían números enteros, lo que es por eso que no es posible agregar de manera confiable un inta TypeScript.

Cuando obtiene inicialmente intelliSense en Visual Studio, no es posible que las herramientas determinen qué suministrar, por lo que obtiene todo, incluido int, pero una vez que esté tratando con algo de un tipo conocido, obtendrá intelliSense sensato.

Ejemplos

var myInt: number;
var myString: string;

myInt. // toExponential, toFixed, toPrecision, toString
myString. // charAt, charCodeAt, concat, indexOf, lastIndexOf, length and many more...

2
Pero eso no responde a mi pregunta sobre cómo anotar mi clase para que los usuarios sepan el tipo de campo adecuado. Además, si "int" nunca es un tipo válido, ¿por qué se incluye en la lista de "todo"?
— Josh

Usas public myVariable : number;para declararlo como un número. intes una palabra reservada en JavaScript, por lo que aparece en la lista de todo. Información sobre JavaScript int: javascript.about.com/od/reference/g/rint.htm
— Fenton

public discountPercent : numberno le dice al usuario si debe ser un decimal (por ejemplo, 0,10 para el 10%) o un número entero (por ejemplo, 10 para el 10%). ¿No hay forma de anotar al usuario de la biblioteca qué es válido y qué no?
— Josh

@JoshuaBeall: no hay diferenciación entre decimal y entero en JavaScript o TypeScript. El tipo de número se utiliza para ambos.
— Fenton

1
@Fenton dijiste: "TypeScript es un superconjunto de JavaScript, que no tiene el concepto de un int. Solo tiene el concepto de un número, que tiene un punto flotante". Es cierto, pero en realidad es posible implementar un inttipo en TypeScript, solo que eligieron no hacerlo.
— trusktr

15

No hay integero floatpero numberescribe en TypeScript como en JavaScript. Pero si quiere decirle al programador que espera un integertipo, puede intentar usar Alias ​​de tipo como

type integer = number;
type float = number;

// example:
function setInt(id: integer) {}

pero esto sigue siendo numbertipo y puedes conseguirlo float.

Parte de la descripción de la documentación:
"La creación de alias no crea un nuevo tipo, crea un nuevo nombre para referirse a ese tipo. Alias ​​una primitiva no es muy útil, aunque puede usarse como una forma de documentación".


8

En TypeScript, puede aproximar lo que a veces se llama un tipo opaco usando un marcador.

// Helper for generating Opaque types.
type Opaque<T, K> = T & { __opaque__: K };

// 2 opaque types created with the helper
type Int = Opaque<number, 'Int'>;
type ID = Opaque<number, 'ID'>;

// using our types to differentiate our properties even at runtime
// they are still just numbers
class Foo {
    someId: ID;
    someInt: Int;
}

let foo = new Foo();

// compiler won't let you do this due to or markers
foo.someId = 2;
foo.someInt = 1;

// when assigning, you have to cast to the specific type
// NOTE: This is not completely type safe as you can trick the compiler 
// with something like foo.someId = 1.45 as ID and it won't complain.
foo.someId = 2 as ID;
foo.someInt = 1 as Int;

// you can still consume as numbers
let sum: number = foo.someId + foo.someInt;

Hacer esto le permite ser más explícito en su código en cuanto a qué tipos esperan sus propiedades, y el compilador no le permitirá asignar un valor primitivo sin una conversión. Esto no produce ninguna salida .js adicional, y aún puede consumir y usar los valores como los tipos en los que se basan. En este ejemplo, estoy usando números, pero también puedes usarlos en cadenas y otros tipos.

Aún puede engañar al compilador para que acepte algo que no sea un Int o un Id en este ejemplo, pero debería saltar si estuviera tratando de asignar 1.45 como Int o algo así. También tiene la opción de crear funciones auxiliares que usa para crear sus valores para proporcionar validación en tiempo de ejecución.

Hay varias formas de crear tipos "marcados". Aquí hay un buen artículo: https://michalzalecki.com/nominal-typing-in-typescript/


Como se dijo en otra parte, la usabilidad real de esto es algo cuestionable, pero puede ir más allá agregando un typeguard y / o un Casting-Helper, que será fácil para algunas cosas, como el ejemplo de Int, y prácticamente imposible para otras, como el ejemplo de ID: // @ts-ignore const isInt = (val: number | Int): val is Int => !(val % 1); const Integer = (val: number): Int => Math.round(val) as any;
— Sam96

4

Este es el mejor resultado en Google para mí, así que supongo que debería proporcionar las soluciones que encontré.

Utilizando bigint

Ahora que es 2020 y bigintha sido aceptado, merece una mención. Simplemente puede hacer lo siguiente. Tenga en cuenta que biginttienen un impacto mayor en el rendimiento en comparación con a number.

const myNumber: bigint = 10n


Usando un tipo nominal / tipo etiquetado / tipo opaco

Una alternativa es usar un tipo nominal, pero podría decirse que es menos ergonómico y no estoy seguro si es más rápido que bigint, pero el patrón se generaliza a cualquier tipo, no solo number. TypeScript no tiene soporte de "primera clase" para esto, así que tienes que hacer un truco descarado. Hay una biblioteca para esto llamado newtype-tsque incluye tipos comunes comoInteger por lo que es posible que solo desee usar eso, pero explicaré el funcionamiento a continuación.

Para empezar definimos el integertipo.

const TAG = Symbol()
type integer = number & { readonly [TAG]: unique symbol }

los TAG asegura que tengamos un valor único para que no creemos accidentalmente un objeto con la misma clave, y también convertimos el campo en un símbolo único por la misma razón. Ahora, su número entero no tendrá este campo de objeto, pero está bien.

Con esto, aún puede agregar integeral numberuso +. No está bien. Por lo tanto, puede aplicar la seguridad de tipos en los argumentos aquí masajeando el sistema de tipos con una función. Solo lo llamaré guardia, y nuevamente, como puede ver, no es específico de integers: podría hacer tipos más opacos y usar esto nuevamente.

type guard = <A>(f: (...ns: Array<A>) => A, ...ns: Array<A>) => A
const guard: guard = (f, ...ns) => f(...ns)

Si intentas llamar a eso con un number

const bad: integer = guard((a, b) => a + b as integer, myCoolInteger, 10)

obtendrá un error como el siguiente

Argument of type '10' is not assignable to parameter of type 'integer'.
  Type '10' is not assignable to type '{ readonly [TAG]: unique symbol; }'.(2345)

Tenga en cuenta que no está imponiendo el tipo de retorno aquí (porque tiene que usarlo as integer) y algunos operadores como /devolverán números de punto flotante, por lo que probablemente aún desee realizar verificaciones en tiempo de ejecución o agregar Math.rounda una versión especializada de guard, pero esto al menos lo hará asegurarse de que no está tratando de utilizar dos tipos numéricos separados entre sí - imagina que tienes GBPy USDe intentar añadir los que probablemente no sería lo que pretende.


2

Bueno, como ha visto, el mecanografiado no tiene tipos de datos flotantes como el lenguaje javascript. Solo tenga el numberque cubra todo inty doubleal mismo tiempo; tal vez deba hacer una función que tome un número y verifique si es un into double, devolviendo algún estado en caso de error / éxito. Algo como esto como método de tu clase:

function SetN(x:number) {
   var is_int = parseInt(x) === parseFloat(x);
   if(is_int) this.n = x;
   return is_int;
}

//..
y = 10.5;
if(SetN(y)) {
  //OK
} else {
   //error not set y isn't a int
}

Nota: no funciona para, 10.0por ejemplo, si realmente no lo desea, tal vez deba convertirlo en una cadena e intentar encontrar un archivo ..


Esto ayudaría a la aplicación del tiempo de ejecución, pero lo que más me interesa es informar al usuario qué números son válidos.
— Josh

1

intestaba reservado para uso futuro palabra clave en versiones anteriores de javascript (ECMAScript si lo prefiere). Pero es una palabra válida ahora (donde "ahora" equivale a "en la última especificación").

Por ejemplo, en 262 todavía estaba reservado, http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-262.pdf

Sería una buena adición al mecanografiado tener un inttipo de datos implementado pero con todas las reglas de conversión y verificación de tipos en tiempo de compilación disponibles.


Entonces, ¿quizás el intellisense está captando esta "palabra reservada" aunque no sea reconocida por el compilador?
— Josh

Al usar nuestro sitio, usted reconoce que ha leído y comprende nuestra Política de Cookies y Política de Privacidad.
Licensed under cc by-sa 3.0 with attribution required.