Skip to content

Allow quoted names in ambient contexts #9846

Closed
Closed
Allow quoted names in ambient contexts#9846
Labels
SuggestionAn idea for TypeScriptToo ComplexAn issue which adding support for may be too complex for the value it adds

Description

@RyanCavanaugh
Ryan Cavanaugh (RyanCavanaugh)
opened on Jul 20, 2016

The node module yargs is callable (typeof require('yargs') === 'function'). It also has a property named default that is a function.

This makes writing a definition file very difficult. You'd be inclined to write

declare function yargs(): void;
declare namespace yargs {
  /* dozens of other things */
  function default(): void; // syntax error
}
export = yargs;

There's not an obvious workaround that doesn't have bad side effects (e.g. rewriting the whole mess as a var doesn't really work in the case where there's a nested class), possibly requiring a massive restructuring of the entire file.

Wherever an identifier appears in an ambient context where it could have been initialized as a property, it should be allowed to be quoted. For example

export const "default": string;
declare namespace foo {
  function "with"(): string;
}

Activity

  1. Ryan Cavanaugh (RyanCavanaugh)
    added
    SuggestionAn idea for TypeScript
    In DiscussionNot yet reached consensus
    on Jul 20, 2016

  2. RyanCavanaugh commented on Aug 9, 2016

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Aug 9, 2016
    MemberAuthor

    This actually prevents some objects from being correctly represented. Consider if you had some object foo that was legal to use as

    class d extends foo.var { }
let d = new foo.var();
let e = foo.default;
  3. Ryan Cavanaugh (RyanCavanaugh)
    added
    Too ComplexAn issue which adding support for may be too complex for the value it adds
    and removed
    In DiscussionNot yet reached consensus
    on Aug 22, 2016
  4. Ryan Cavanaugh (RyanCavanaugh)
    closed this as completedon Aug 22, 2016

  5. RyanCavanaugh commented on Jul 14, 2017

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Jul 14, 2017
    MemberAuthor

    https://github.com/DefinitelyTyped/DefinitelyTyped/pull/17985/files#diff-ca41bc5f580b39365289711693a2ac6cR19

  6. BendingBender commented on Jul 22, 2017

    @BendingBender
    Dimitri B. (BendingBender)
    on Jul 22, 2017

    https://github.com/DefinitelyTyped/DefinitelyTyped/pull/18309/files#diff-c892b71507d5d1f0e96637ae3684df9eR60

  7. RyanCavanaugh commented on Nov 29, 2017

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Nov 29, 2017
    MemberAuthor

    DefinitelyTyped/DefinitelyTyped#21749

  8. mhegazy commented on Nov 29, 2017

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Nov 29, 2017
    Contributor

    Note that export { x as y} is legal in a namespace in an ambient context. so the issue in the OP can be written as:

    declare function yargs(): void;
declare namespace yargs {
    function _default(): void; 
    export { _default as _default };
}
export = yargs;
  9. microsoft
    locked and limited conversation to collaborators on Jun 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    SuggestionAn idea for TypeScriptToo ComplexAn issue which adding support for may be too complex for the value it adds

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions