Skip to content

"external types" for d.ts files dependent on others #1402

Closed

Description

d.ts files on DefinitelyTyped frequently depend on other declaration files.

interface JSZipObject {
  name: string;
  dir: boolean;
  date: Date;
  comment: string;
  options: JSZipObjectOptions;

  asText(): string;
  asBinary(): string;
  asArrayBuffer(): ArrayBuffer;
  asUint8Array(): Uint8Array;
  //asNodeBuffer(): Buffer; <-- Disabled to prevent node.d.ts dependency
}

Bigger d.ts files depend on multiple big d.ts files, which again depend on others. (Example: atom.d.ts, ...) Collecting all those required files may not only be painful but also be unnecessary, especially for those who just want to use a specific part of a d.ts file that is not dependent on anything.

A method to specify external types can help here, allowing users to exclude unwanted declaration files.

// jszip.d.ts
/// <reference path="../node/node.d.ts" />
external interface Buffer: "../node/node.d.ts";

// use.d.ts
/// <referernce path="jszip.d.ts" />
var zip: JSZipObject;
var text = zip.asText(); // works fine without node.d.ts

var buffer = zip.asNodeBuffer(); // typeof any when there is no node.d.ts;
// No error but a warning: "interface Buffer should be defined by "node.d.ts"

interface Buffer { } may just work here, but not for classes as they are not open-ended.

// bar.d.ts
/// <reference path="foo.d.ts" />;
external class Foo: "foo.d.ts"; // This should not block Foo definition by foo.d.ts
interface Bar {
  foo: Foo;
}

Activity

  1. danquirk commented on Dec 8, 2014

    @danquirk
    Member

    This should be covered by ES6 module alignment. See the named import functionality like what's in 5.1 here http://www.2ality.com/2014/09/es6-modules-final.html We wouldn't want to do any TS specific syntax here that risks incompatibility with ES6+ versions.

  2. added
    Too ComplexAn issue which adding support for may be too complex for the value it adds
    Out of ScopeThis idea sits outside of the TypeScript language design constraints
    DeclinedThe issue was declined as something which matches the TypeScript vision
    on Dec 8, 2014
  3. saschanaz commented on Dec 9, 2014

    @saschanaz
    ContributorAuthor

    Thank you for the information! :)

  4. locked and limited conversation to collaborators on Jun 18, 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

    DeclinedThe issue was declined as something which matches the TypeScript visionOut of ScopeThis idea sits outside of the TypeScript language design constraintsToo 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