Skip to content

Commit

Permalink
Note that TS support is provisional
Browse files Browse the repository at this point in the history
Ref: First-party Typescript support #3306
  • Loading branch information
maxkfranz committed Jan 10, 2025
1 parent 267d243 commit abc1251
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@
// TypeScript Version: 2.3

/**
* WARNING: This is a provisional specification of the Cytoscape.js
* API in TypeScript, based on improvements made on the Typescript
* specification for Cytoscape.js in DefinitelyTyped. This is a work
* in progress and may not be complete, and it may have errors. Please
* report any issues to the issue tracker:
*
* https://github.com/cytoscape/cytoscape.js/issues
*
* cy --> Cy.Core
* the core
*
Expand Down Expand Up @@ -50,11 +58,20 @@
* - Cy.NodeCollection
* The output is a collection of node elements OR single node.
*
* A number of interfaces contain nothing as they server to collect interfaces.
* A number of interfaces contain nothing as they serve to collect interfaces.
*/
export = cytoscape;
export as namespace cytoscape;

/**
* WARNING: This is a provisional specification of the Cytoscape.js
* API in TypeScript, based on improvements made on the Typescript
* specification for Cytoscape.js in DefinitelyTyped. This is a work
* in progress and may not be complete, and it may have errors. Please
* report any issues to the issue tracker:
*
* https://github.com/cytoscape/cytoscape.js/issues
*/
declare function cytoscape(options?: cytoscape.CytoscapeOptions): cytoscape.Core;
declare function cytoscape(type: string, name: string): unknown;
declare function cytoscape(type: string, name: string, registrant: any): void;
Expand Down

0 comments on commit abc1251

Please sign in to comment.