From abc12515fc61eae7e6f194d4e369c88d913ab070 Mon Sep 17 00:00:00 2001 From: Max Franz Date: Fri, 10 Jan 2025 12:05:47 -0500 Subject: [PATCH] Note that TS support is provisional Ref: First-party Typescript support #3306 --- index.d.ts | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/index.d.ts b/index.d.ts index 1a2eacf51..009712d27 100644 --- a/index.d.ts +++ b/index.d.ts @@ -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 * @@ -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;