Suggestion: Infer literal types for getter only properties that return literals

[aluanhaddad]

Suggestion: Infer literal types for getter only properties that return literals.

This suggestion arose from reading #11465 the example below comes directly from that issue.

TypeScript Version: nightly (2.0.0-dev.20161008)

Code

// A *self-contained* demonstration of the problem follows...
import React, { Component } from 'react';
import { StyleSheet, Text } from 'react-native';

export class Sample extends Component<{}, {}> {
    render() {
        return (
            <Text style={styles.text}>Hello TypeScript</Text> // error on styles, see below
        );
    }
}

const styles = StyleSheet.create({
    text: {
        position: 'absolute', // cause of the error: string instead of 'absolute'
        top: 0,
        left: 0     
    }
});

I tried a different workaround than the ones presented by @jovdb in #11465

const styles = StyleSheet.create({
  text: {
      get position() { return 'absolute'; },
      top: 0,
      left: 0
    }
});

Expected behavior:
The type of text.position is inferred as 'absolute'
Actual behavior:
The type of text.position is inferred as string

My reasoning here is that while the following rules, outlined in #10676, make complete sense in general, they are not ideal for getter only properties

• In a function with no return type annotation, if the inferred return type is a literal type (but not a literal union type) and the function does not have a contextual type with a return type that includes literal types, the return type is widened to its widened literal type.
• The type inferred for a property in an object literal is the widened literal type of the expression unless the property has a contextual type that includes literal types.

I am not sure if both of these rules apply here or only the second.

[HerringtonDarkholme]

Probably a bug in spec, IMHO.
in #10676

The type inferred for a const variable or readonly property without a type annotation is the type of the initializer as-is.

And in #6532

A property declared with a get accessor and no set accessor is considered read-only.

An implicitly readonly property, namely get only accessor, should also be inferred as literal type if possible.

The type inferred for a property in an object literal is the widened literal type of the expression unless the property has a contextual type that includes literal types.

The above rule does not apply here because the contextual type Stylesheet.create does not have literal type.

[aluanhaddad]

It is interesting to see the behavior in classes because both readonly qualified properties and get accessors can be explicitely defined.

[aluanhaddad]

If #11535 gets adopted, this could be accomplished via

const styles = StyleSheet.create({
  text: Object.freeze({
      position: 'absolute',
      top: 0,
      left: 0
    })
});

[ghost]

Possibly related:

function id<T>(x: T) { return x; }
function wrap<T>(value: T): { readonly value: T } { return { value }; }

const s: "s" = id("s"); // Works, inferred id<"s">
const vs: { readonly value: "s" } = wrap("s"); // Error, inferred wrap<string>

[aluanhaddad]

Interesting, it seems like the literal type is only inferred for id and not for wrap. I had to use an overload to make it typecheck

function wrap<T extends string>(value: T);
function wrap<T>(value: T);
function wrap<T>(value: T): { readonly value: T } { return { value }; }

[RyanCavanaugh]

Experience in real code shows that getters sometimes have function-like behavior (where you would want the nonliteral type) and sometimes have property-like behavior (where you may want the literal type). In general, mostly due to back compat problems, we defer to nonliteral types when it isn't clear from context that you need one.

[aluanhaddad]

@RyanCavanaugh thank you for explaining the reasoning, I really appreciate it.

[ghost]

@RyanCavanaugh Shall I make a separate issue for my earlier comment?