diff --git a/.gitignore b/.gitignore
index f64d5c3..bcf4259 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,6 +1,8 @@
**/.DS_Store
node_modules
deprecated
-dist
package-lock.json
-app/mixfile.js*
+dist/wmk
+dist/src
+dist/work
+dist/cdd
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
index 342340b..1db52b8 100644
--- a/.vscode/tasks.json
+++ b/.vscode/tasks.json
@@ -1,20 +1,17 @@
{
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks":
[
{
- "label": "build",
- "type": "typescript",
- "tsconfig": "tsconfig.json",
- "problemMatcher":
- [
- "$tsc"
- ],
+ "type": "npm",
+ "script": "build",
"group":
{
"kind": "build",
"isDefault": true
- }
+ }
}
]
}
\ No newline at end of file
diff --git a/app/console.js b/app/console.js
index 6b231de..9214ea6 100644
--- a/app/console.js
+++ b/app/console.js
@@ -10,6 +10,6 @@
Made available under the Gnu Public License v3.0
*/
-let Mixtures = require(__dirname + '/mixfile.js');
+let Mixtures = require(__dirname + '/mixtures-electron.js');
new Mixtures.Console(process.argv.slice(0)).run().then();
diff --git a/app/index.html b/app/index.html
index 88d0355..656775f 100644
--- a/app/index.html
+++ b/app/index.html
@@ -6,12 +6,12 @@
-
+
-
+
@@ -44,32 +45,31 @@ Mixfile Editor - Web Demo
import molfileToInChI from './inchi-run.js';
Mixtures.InChI.nativeMolfileToInChI = molfileToInChI;
- //import {Mixtures, WebMolKit} from './mixfile.js';
- let wmk = WebMolKit;
+ const {dom, DOM} = Mixtures;
- wmk.initWebMolKit('res');
+ Mixtures.initWebMolKit('res');
var widget = new Mixtures.WebWidget();
- var mixture = new Mixtures.Mixture(JSON.parse(wmk.dom('#data').text()));
- widget.render(wmk.DOM.find('#root'), 700, 600);
+ var mixture = new Mixtures.Mixture(JSON.parse(DOM.find('#data').getText()));
+ widget.render(DOM.find('#root'), 700, 600);
widget.setMixture(mixture);
- let btnMInChI = wmk.dom('').appendTo(wmk.DOM.find('#buttons'));
- btnMInChI.click(() =>
+ let btnMInChI = dom('').appendTo(DOM.find('#buttons'));
+ btnMInChI.onClick(() =>
{
if (widget.isBlank())
{
alert('Mixture is empty.');
return;
}
- wmk.DOM.find('#minchi').empty();
+ DOM.find('#minchi').empty();
let mixture = widget.getMixture();
let maker = new Mixtures.ExportMInChI(mixture.mixfile);
maker.fillInChI().then(() =>
{
maker.formulate();
- let pre = wmk.dom('').appendTo(wmk.DOM.find('#minchi')).css({'padding-top': '0.5em'});
- pre.text(maker.getResult());
+ let pre = dom('').appendTo(DOM.find('#minchi')).css({'padding-top': '0.5em'});
+ pre.setText(maker.getResult());
pre.append('\n');
pre.append(maker.getSegment().join(''));
});
diff --git a/dist/index-electron.ts b/dist/index-electron.ts
new file mode 100644
index 0000000..4e858b6
--- /dev/null
+++ b/dist/index-electron.ts
@@ -0,0 +1,8 @@
+export * from './index-web';
+
+export * from '../src/startup';
+export * from '../src/cmdline/Console';
+export * from '../src/cmdline/RenderHTML';
+export * from '../src/cmdline/TableExtract';
+export * from '../src/cmdline/TransformMixtures';
+
diff --git a/dist/index-web.ts b/dist/index-web.ts
new file mode 100644
index 0000000..e16dafb
--- /dev/null
+++ b/dist/index-web.ts
@@ -0,0 +1,35 @@
+export * from '../wmk/util/dom';
+export * from '../wmk/util/util';
+export * from '../wmk/util/Theme';
+export * from '../wmk/util/Vec';
+export * from '../wmk/util/XML';
+
+export * from '../src/data/Mixfile';
+export * from '../src/data/Mixture';
+export * from '../src/data/MixtureCollection';
+export * from '../src/data/NormMixture';
+export * from '../src/data/Units';
+
+export * from '../src/lookup/ExtractCTABComponent';
+export * from '../src/lookup/LookupCompoundDialog';
+export * from '../src/lookup/PubChemSearch';
+
+export * from '../src/main/CollectionPanel';
+export * from '../src/main/InChI';
+export * from '../src/main/MainPanel';
+export * from '../src/main/MenuBanner';
+export * from '../src/main/MixturePanel';
+
+export * from '../src/mixture/ArrangeMixture';
+export * from '../src/mixture/DrawMixture';
+export * from '../src/mixture/EditComponent';
+export * from '../src/mixture/EditMixture';
+export * from '../src/mixture/ExportMInChI';
+export * from '../src/mixture/ExportSDFile';
+export * from '../src/mixture/ImportSDFile';
+export * from '../src/mixture/KeyValueWidget';
+export * from '../src/mixture/MetadataWidget';
+export * from '../src/mixture/SquarePacking';
+
+export * from '../src/web/EditMixtureWeb';
+export * from '../src/web/WebWidget';
\ No newline at end of file
diff --git a/package.json b/package.json
index f4a404e..1752f0f 100644
--- a/package.json
+++ b/package.json
@@ -12,7 +12,10 @@
"@typescript-eslint/parser": "^4.7",
"electron-packager": "^8.1.0",
"eslint": "^7.0",
- "typescript": "^4.6"
+ "ts-loader": "^9.3.1",
+ "typescript": "^4.6",
+ "webpack": "^5.73.0",
+ "webpack-cli": "^4.10.0"
},
"build": {
"appId": "com.cdd.mixture.MixfileEditor",
@@ -21,6 +24,10 @@
}
},
"scripts": {
- "eslint": "eslint -c ../WebMolKit/src/.eslintrc.js --ignore-pattern src/decl --quiet src/**/*.ts"
+ "eslint": "eslint -c ../WebMolKit/src/.eslintrc.js --ignore-pattern src/decl --quiet src/**/*.ts",
+ "build-tsc": "tsc",
+ "build-web": "webpack --config webpack-web.config.js",
+ "build-electron": "webpack --config webpack-electron.config.js",
+ "build": "tsc && webpack --config webpack-web.config.js && webpack --config webpack-electron.config.js"
}
}
diff --git a/src/baselib.ts b/src/baselib.ts
deleted file mode 100644
index 4a02d44..0000000
--- a/src/baselib.ts
+++ /dev/null
@@ -1,34 +0,0 @@
-/*
- Mixfile Editor & Viewing Libraries
-
- (c) 2017-2020 Collaborative Drug Discovery, Inc
-
- All rights reserved
-
- http://collaborativedrug.com
-
- Made available under the Gnu Public License v3.0
-*/
-
-///
-
-// NOTE: imports need to go before we start defining our own stuff, otherwise transpiler order sometimes breaks
-import wmk = WebMolKit;
-import Vec = WebMolKit.Vec;
-import pixelDensity = WebMolKit.pixelDensity;
-import drawLine = WebMolKit.drawLine;
-import escapeHTML = WebMolKit.escapeHTML;
-import pathRoundedRect = WebMolKit.pathRoundedRect;
-import eventCoords = WebMolKit.eventCoords;
-import clone = WebMolKit.clone;
-import deepClone = WebMolKit.deepClone;
-import orBlank = WebMolKit.orBlank;
-import blendRGB = WebMolKit.blendRGB;
-import colourCode = WebMolKit.colourCode;
-import TWOPI = WebMolKit.TWOPI;
-import norm_xy = WebMolKit.norm_xy; // eslint-disable-line
-import newElement = WebMolKit.newElement;
-import DOM = WebMolKit.DOM;
-import dom = WebMolKit.dom;
-
-///
diff --git a/src/cmdline/Console.ts b/src/cmdline/Console.ts
index 83ca7fd..b20edbb 100644
--- a/src/cmdline/Console.ts
+++ b/src/cmdline/Console.ts
@@ -10,7 +10,12 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {XML} from '../../wmk/util/XML';
+import {InChI} from '../main/InChI';
+import {setOnDesktop} from '../startup';
+import {RenderHTML} from './RenderHTML';
+import {TableExtract} from './TableExtract';
+import {ALL_TRANSFORMMIXTURE_FORMATS, TransformMixtures} from './TransformMixtures';
/*
Console utilities, to be run from NodeJS with command line arguments.
@@ -32,11 +37,11 @@ export class Console
constructor(args:string[])
{
- ON_DESKTOP = true;
+ setOnDesktop(true);
const {DOMParser, XMLSerializer} = require('xmldom/dom-parser.js');
- wmk.XML.customParser = DOMParser;
- wmk.XML.customSerial = XMLSerializer;
+ XML.customParser = DOMParser;
+ XML.customSerial = XMLSerializer;
for (let n = 0; n < args.length; n++)
{
@@ -94,6 +99,4 @@ export class Console
}
// if being run in NodeJS context, need to export the class
-if (typeof module == 'object') module.exports['Console'] = Console;
-
-/* EOF */ }
\ No newline at end of file
+//if (typeof module == 'object') module.exports['Console'] = Console;
diff --git a/src/cmdline/RenderHTML.ts b/src/cmdline/RenderHTML.ts
index 6bcc9bc..5abd9cd 100644
--- a/src/cmdline/RenderHTML.ts
+++ b/src/cmdline/RenderHTML.ts
@@ -10,7 +10,14 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {OutlineMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {MetaVector} from '../../wmk/gfx/MetaVector';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {escapeHTML} from '../../wmk/util/util';
+import {MixtureCollection} from '../data/MixtureCollection';
+import {ArrangeMixture} from '../mixture/ArrangeMixture';
+import {DrawMixture} from '../mixture/DrawMixture';
+import {ExportMInChI, MInChISegment} from '../mixture/ExportMInChI';
/*
Loads a mixture collection and emits it as visualisable HTML.
@@ -49,8 +56,8 @@ export class RenderHTML
emitln('');
- let policy = wmk.RenderPolicy.defaultColourOnWhite(15);
- let measure = new wmk.OutlineMeasurement(0, 0, policy.data.pointScale);
+ let policy = RenderPolicy.defaultColourOnWhite(15);
+ let measure = new OutlineMeasurement(0, 0, policy.data.pointScale);
for (let n = 0; n < mixlist.count; n++)
{
@@ -62,7 +69,7 @@ export class RenderHTML
let layout = new ArrangeMixture(mixture, measure, policy);
layout.arrange();
- let gfx = new wmk.MetaVector();
+ let gfx = new MetaVector();
let draw = new DrawMixture(layout, gfx);
draw.draw();
gfx.normalise();
@@ -102,4 +109,3 @@ export class RenderHTML
// ------------ private methods ------------
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/cmdline/TableExtract.ts b/src/cmdline/TableExtract.ts
index 6b2f19d..ec73c99 100644
--- a/src/cmdline/TableExtract.ts
+++ b/src/cmdline/TableExtract.ts
@@ -10,7 +10,18 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {AssayProvenance} from '../../wmk/aspect/AssayProvenance';
+import {MeasurementData} from '../../wmk/aspect/MeasurementData';
+import {Mixture as wmkMixture} from '../../wmk/aspect/Mixture';
+import {DataSheet} from '../../wmk/data/DataSheet';
+import {DataSheetStream} from '../../wmk/data/DataSheetStream';
+import {MDLSDFReader} from '../../wmk/data/MDLReader';
+import {MDLMOLWriter} from '../../wmk/data/MDLWriter';
+import {Molecule} from '../../wmk/data/Molecule';
+import {Vec} from '../../wmk/util/Vec';
+import {MixfileComponent} from '../data/Mixfile';
+import {Mixture} from '../data/Mixture';
+import {MixtureCollection} from '../data/MixtureCollection';
/*
Table extraction: create Mixfile instances from tabular data sources, with the help of directions for placing columns into
@@ -45,11 +56,11 @@ export class TableExtract
private fs = require('fs');
private path = require('path');
- private table:wmk.DataSheet = null;
- private aprov:wmk.AssayProvenance = null;
- private mdata:wmk.MeasurementData = null;
+ private table:DataSheet = null;
+ private aprov:AssayProvenance = null;
+ private mdata:MeasurementData = null;
- private lookup:Map = null;
+ private lookup:Map = null;
private mappings:TableExtractMapping[] = [];
constructor(private tableFile:string, private lookupFile:string, private mappingFile:string, private verbose:boolean)
@@ -62,14 +73,14 @@ export class TableExtract
try {content = this.fs.readFileSync(this.tableFile).toString();}
catch (ex) {throw 'Unable to read file ' + this.tableFile + ': ' + ex;}
- if (this.tableFile.endsWith('.ds')) this.table = wmk.DataSheetStream.readXML(content);
- else if (this.tableFile.endsWith('.sdf')) this.table = new wmk.MDLSDFReader(content).parse();
+ if (this.tableFile.endsWith('.ds')) this.table = DataSheetStream.readXML(content);
+ else if (this.tableFile.endsWith('.sdf')) this.table = new MDLSDFReader(content).parse();
else if (this.tableFile.endsWith('.csv')) this.table = this.parseLines(',', true);
else if (this.tableFile.endsWith('.tsv') || this.tableFile.endsWith('.tab')) this.table = this.parseLines('\t', false);
if (!this.table) throw 'Unable to parse: ' + this.tableFile;
- if (wmk.AssayProvenance.isAssayProvenance(this.table)) this.aprov = new wmk.AssayProvenance(this.table, false);
- if (wmk.MeasurementData.isMeasurementData(this.table)) this.mdata = new wmk.MeasurementData(this.table, false);
+ if (AssayProvenance.isAssayProvenance(this.table)) this.aprov = new AssayProvenance(this.table, false);
+ if (MeasurementData.isMeasurementData(this.table)) this.mdata = new MeasurementData(this.table, false);
if (this.lookupFile)
{
@@ -98,9 +109,9 @@ export class TableExtract
// ------------ private methods ------------
// read TSV/CSV file, which is presumed to have column headings, and may include escape sequences
- private parseLines(sep:string, escaped:boolean):wmk.DataSheet
+ private parseLines(sep:string, escaped:boolean):DataSheet
{
- let ds = new wmk.DataSheet();
+ let ds = new DataSheet();
// !! load each line, split into strings, apply columns then rows...
// !! anything that's all {int} or {real} gets changed retroactively
@@ -111,9 +122,9 @@ export class TableExtract
// extract column-to-mixture information embedded in the initial datasheet, if possible
private initialMapping():void
{
- if (!wmk.Mixture.isMixture(this.table)) return;
+ if (!wmkMixture.isMixture(this.table)) return;
- let aspect = new wmk.Mixture(this.table, false);
+ let aspect = new wmkMixture(this.table, false);
for (let attr of aspect.getHeader().attributes)
{
let map:TableExtractMapping =
@@ -174,7 +185,7 @@ export class TableExtract
if (map.type == TableExtractType.Structure)
{
let mol = this.table.getMolecule(row, col);
- comp.molfile = new wmk.MDLMOLWriter(mol).write();
+ comp.molfile = new MDLMOLWriter(mol).write();
}
else if (map.type == TableExtractType.Name)
{
@@ -183,7 +194,7 @@ export class TableExtract
else if (map.type == TableExtractType.Quantity)
{
// if aspected: can extract more information
- if (this.aprov && map.column == wmk.AssayProvenance.COLNAME_VALUE)
+ if (this.aprov && map.column == AssayProvenance.COLNAME_VALUE)
{
comp.quantity = this.aprov.getValue(row);
let error = this.aprov.getError(row);
@@ -292,4 +303,3 @@ export class TableExtract
}
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/cmdline/TransformMixtures.ts b/src/cmdline/TransformMixtures.ts
index 4b2053e..ab5b12c 100644
--- a/src/cmdline/TransformMixtures.ts
+++ b/src/cmdline/TransformMixtures.ts
@@ -10,7 +10,18 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {OutlineMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {MetaVector} from '../../wmk/gfx/MetaVector';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {Vec} from '../../wmk/util/Vec';
+import {Mixfile} from '../data/Mixfile';
+import {Mixture} from '../data/Mixture';
+import {InChI} from '../main/InChI';
+import {ArrangeMixture} from '../mixture/ArrangeMixture';
+import {DrawMixture} from '../mixture/DrawMixture';
+import {ExportMInChI} from '../mixture/ExportMInChI';
+import {ExportSDFile} from '../mixture/ExportSDFile';
+import {ImportSDFile} from '../mixture/ImportSDFile';
/*
Reads a stream of mixtures and writes it out as a stream, with format transformation as necessary.
@@ -230,12 +241,12 @@ export class TransformMixtures
}
else if (this.outputFormat == TransformMixtureFormat.SVG)
{
- let policy = wmk.RenderPolicy.defaultColourOnWhite(20);
- let measure = new wmk.OutlineMeasurement(0, 0, policy.data.pointScale);
+ let policy = RenderPolicy.defaultColourOnWhite(20);
+ let measure = new OutlineMeasurement(0, 0, policy.data.pointScale);
let layout = new ArrangeMixture(new Mixture(mixfile), measure, policy);
layout.arrange();
- let gfx = new wmk.MetaVector();
+ let gfx = new MetaVector();
new DrawMixture(layout, gfx).draw();
gfx.normalise();
let svg = gfx.createSVG(false);
@@ -262,5 +273,3 @@ export class TransformMixtures
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/data/Mixfile.ts b/src/data/Mixfile.ts
index 5588c8e..dd137b3 100644
--- a/src/data/Mixfile.ts
+++ b/src/data/Mixfile.ts
@@ -10,8 +10,6 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
-
/*
The Mixfile is a raw definition of the contents of a mixture, which maps directly to the JSON datastructure
that holds the serialised content. For keeping an operable mixture instance, see the Mixture class.
@@ -73,93 +71,3 @@ export const MIXFILE_ROOT_FIELDS =
[
'mixfileVersion', ...MIXFILE_COMPONENT_FIELDS
];
-
-/* orignal example of what the format might look like (1st draft):
-{
- "mixture": "1.0 M lithium diisopropyl amide in THF/hexanes",
- "contents":
- [
- {
- "name": "lithium diisopropylamide",
- "synonyms": ["LDA", "(iPr)2N.Li"],
- "formula": "C6H14LiN",
- "pubchem": "2724682",
- "chemspider": "2006804",
- "inchi": "InChI=1S/C6H14N.Li/c1-5(2)7-6(3)4;/h5-6H,1-4H3;/q-1;+1",
- "smiles": "[Li+].CC(C)[N-]C(C)C",
- "molfile": "\nOpenMolecule\n\n 8 7 0 0 0 0 0 0 0 0999 V2000\n 0.0000 0.0000 0.0000 N 0 0 0 0 0 0 0 0 0 0 0 0\n 1.5000 0.0000 0.0000 Li 0 0 0 0 0 0 0 0 0 0 0 0\n -0.7500 1.2990 0.0000 C 0 0 0 0 0 0 0 0 0 0 0 0\n -0.7500 -1.2990 0.0000 C 0 0 0 0 0 0 0 0 0 0 0 0\n -0.0000 2.5981 0.0000 C 0 0 0 0 0 0 0 0 0 0 0 0\n -2.2500 1.2990 0.0000 C 0 0 0 0 0 0 0 0 0 0 0 0\n 0.0000 -2.5981 0.0000 C 0 0 0 0 0 0 0 0 0 0 0 0\n -2.2500 -1.2990 0.0000 C 0 0 0 0 0 0 0 0 0 0 0 0\n 1 2 1 0 0 0 0\n 1 3 1 0 0 0 0\n 1 4 1 0 0 0 0\n 3 5 1 0 0 0 0\n 3 6 1 0 0 0 0\n 4 7 1 0 0 0 0\n 4 8 1 0 0 0 0\nM END\n",
- "quantity": 1.0,
- "units": "mol/L"
- },
- {
- "group": "solvent",
- "contents":
- [
- {
- "name": "tetrahydrofuran",
- "synonyms": ["THF"],
- "formula": "C4H8O",
- "pubchem": "8028",
- "chemspider": "7737",
- "inchi": "InChI=1S/C4H8O/c1-2-4-5-3-1/h1-4H2",
- "smiles": "C1CCOC1",
- "molfile": "...",
- "fraction": [1, 8]
- },
- {
- "group": "hexanes",
- "fraction": [7, 8],
- "contents":
- [
- {
- "name": "n-hexane",
- "formula": "C6H14",
- "pubchem": "8058",
- "chemspider": "7767",
- "inchi": "InChI=1S/C6H14/c1-3-5-6-4-2/h3-6H2,1-2H3",
- "smiles": "CCCCCC",
- "molfile": "...",
- "percentage": [50, 70]
- },
- {
- "name": "methylcyclopentane",
- "formula": "C6H14",
- "pubchem": "7296",
- "chemspider": "7024",
- "inchi": "InChI=1S/C6H12/c1-6-4-2-3-5-6/h6H,2-5H2,1H3",
- "smiles": "CC1CCCC1",
- "molfile": "...",
- "percentage": [10, 20]
- },
- {
- "name": "2-methypentane",
- "formula": "C6H14",
- "pubchem": "7892",
- "chemspider": "7604",
- "inchi": "InChI=1S/C6H14/c1-4-5-6(2)3/h6H,4-5H2,1-3H3",
- "smiles": "CCCC(C)C",
- "molfile": "...",
- "percentage": [1, 5]
- },
- {
- "name": "3-methylpentane",
- "formula": "C6H14",
- "pubchem": "7282",
- "chemspider": "7010",
- "inchi": "InChI=1S/C6H14/c1-4-6(3)5-2/h6H,4-5H2,1-3H3",
- "smiles": "CCC(C)CC",
- "molfile": "...",
- "percentage": [1, 5]
- },
- {
- "name": "other hexanes"
- }
- ]
- }
- ]
- }
- ]
-}
-*/
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/data/Mixture.ts b/src/data/Mixture.ts
index d825788..5a6d90e 100644
--- a/src/data/Mixture.ts
+++ b/src/data/Mixture.ts
@@ -10,7 +10,9 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {deepClone} from '../../wmk/util/util';
+import {Vec} from '../../wmk/util/Vec';
+import {Mixfile, MixfileComponent, MIXFILE_VERSION} from './Mixfile';
/*
Data container for mixtures: basically wraps the Mixfile interface, with additional functionality.
@@ -277,5 +279,3 @@ export class Mixture
return true;
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/data/MixtureCollection.ts b/src/data/MixtureCollection.ts
index 245749d..39ced5a 100644
--- a/src/data/MixtureCollection.ts
+++ b/src/data/MixtureCollection.ts
@@ -10,7 +10,8 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {Mixfile} from './Mixfile';
+import {Mixture} from './Mixture';
/*
Collection of mixtures: convenience methods for handling an array thereof, including serialisation.
@@ -106,5 +107,3 @@ export class MixtureCollection
// ------------ private methods ------------
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/data/NormMixture.ts b/src/data/NormMixture.ts
index 8126fd4..1a58c25 100644
--- a/src/data/NormMixture.ts
+++ b/src/data/NormMixture.ts
@@ -10,7 +10,13 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {Molecule} from '../../wmk/data/Molecule';
+import {MoleculeStream} from '../../wmk/data/MoleculeStream';
+import {ActivityType, MoleculeActivity, SketchState} from '../../wmk/sketcher/MoleculeActivity';
+import {Vec} from '../../wmk/util/Vec';
+import {MixfileComponent} from './Mixfile';
+import {Mixture} from './Mixture';
+import {StandardUnits, Units} from './Units';
/*
Mixture normalisation options: recommendations for how to make a mixture more conformant. It is up to the caller
@@ -61,10 +67,10 @@ export class NormMixture
let comp = compList[n];
if (comp.molfile && Vec.isBlank(comp.contents))
{
- let mol = wmk.MoleculeStream.readUnknown(comp.molfile);
+ let mol = MoleculeStream.readUnknown(comp.molfile);
if (!mol) continue;
let stereo = this.enumerateStereo(mol);
- if (Vec.notBlank(stereo)) note.stereoEnum = stereo.map((mol) => wmk.MoleculeStream.writeMDLMOL(mol));
+ if (Vec.notBlank(stereo)) note.stereoEnum = stereo.map((mol) => MoleculeStream.writeMDLMOL(mol));
}
this.notes.push(note);
@@ -204,18 +210,18 @@ export class NormMixture
// ------------ private methods ------------
// if the given molecule has stereogenic centres (i.e. wavy bonds), enumerate them explicitly
- private enumerateStereo(mol:wmk.Molecule):wmk.Molecule[]
+ private enumerateStereo(mol:Molecule):Molecule[]
{
- let splitMolecule = (mol:wmk.Molecule):wmk.Molecule[] =>
+ let splitMolecule = (mol:Molecule):Molecule[] =>
{
- for (let n = 1; n <= mol.numBonds; n++) if (mol.bondType(n) == wmk.Molecule.BONDTYPE_UNKNOWN)
+ for (let n = 1; n <= mol.numBonds; n++) if (mol.bondType(n) == Molecule.BONDTYPE_UNKNOWN)
{
let mol1 = mol.clone(), mol2 = mol.clone();
if (mol.bondOrder(n) == 1)
{
// make up & down versions of the bond
- mol1.setBondType(n, wmk.Molecule.BONDTYPE_DECLINED);
- mol2.setBondType(n, wmk.Molecule.BONDTYPE_INCLINED);
+ mol1.setBondType(n, Molecule.BONDTYPE_DECLINED);
+ mol2.setBondType(n, Molecule.BONDTYPE_INCLINED);
return [mol1, mol2];
}
else if (mol.bondOrder(n) == 2)
@@ -223,13 +229,13 @@ export class NormMixture
// for a cis/trans double bond, use the sketcher algorithm to rotate it; if the rotation is rejected,
// it'll just return the input molecule, with the stereolabel removed
let mol1 = mol.clone();
- mol1.setBondType(n, wmk.Molecule.BONDTYPE_NORMAL);
+ mol1.setBondType(n, Molecule.BONDTYPE_NORMAL);
- let mol2:wmk.Molecule = null;
+ let mol2:Molecule = null;
if (!mol.bondInRing(n))
{
- let state:wmk.SketchState = {'mol': mol1, 'currentAtom': 0, 'currentBond': n, 'selectedMask': null};
- let activ = new wmk.MoleculeActivity(state, wmk.ActivityType.BondRotate, {});
+ let state:SketchState = {'mol': mol1, 'currentAtom': 0, 'currentBond': n, 'selectedMask': null};
+ let activ = new MoleculeActivity(state, ActivityType.BondRotate, {});
activ.execute();
if (!activ.errmsg && activ.output.mol) mol2 = activ.output.mol;
}
@@ -239,7 +245,7 @@ export class NormMixture
return null;
};
- let list:wmk.Molecule[] = [mol];
+ let list:Molecule[] = [mol];
for (let n = 0; n < list.length; n++)
{
let emols = splitMolecule(list[n]);
@@ -291,4 +297,3 @@ export class NormMixture
}
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/data/Units.ts b/src/data/Units.ts
index f542978..162f2b8 100644
--- a/src/data/Units.ts
+++ b/src/data/Units.ts
@@ -10,9 +10,9 @@
Made available under the Gnu Public License v3.0
*/
-/* eslint-disable @typescript-eslint/naming-convention */
+import {Vec} from '../../wmk/util/Vec';
-namespace Mixtures /* BOF */ {
+/* eslint-disable @typescript-eslint/naming-convention */
/*
Unit definitions and conversions. Units are preferentially stored by URI, displayed by common name, and interconverted
@@ -183,5 +183,3 @@ export class Units
return [mnemonic, Vec.mul(values, scale)];
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/decl/electron.d.ts b/src/decl/electron.d.ts
deleted file mode 100644
index 32c857d..0000000
--- a/src/decl/electron.d.ts
+++ /dev/null
@@ -1,13520 +0,0 @@
-// Type definitions for Electron 7.0.0
-// Project: http://electronjs.org/
-// Definitions by: The Electron Team
-// Definitions: https://github.com/electron/electron-typescript-definitions
-
-//
-///
-
-type GlobalEvent = Event;
-
-declare namespace Electron {
- class Accelerator extends String {
-
- }
-
- interface CommonInterface {
- app: App;
- autoUpdater: AutoUpdater;
- BrowserView: typeof BrowserView;
- BrowserWindowProxy: typeof BrowserWindowProxy;
- BrowserWindow: typeof BrowserWindow;
- ClientRequest: typeof ClientRequest;
- clipboard: Clipboard;
- CommandLine: typeof CommandLine;
- contentTracing: ContentTracing;
- Cookies: typeof Cookies;
- crashReporter: CrashReporter;
- Debugger: typeof Debugger;
- desktopCapturer: DesktopCapturer;
- dialog: Dialog;
- Dock: typeof Dock;
- DownloadItem: typeof DownloadItem;
- globalShortcut: GlobalShortcut;
- inAppPurchase: InAppPurchase;
- IncomingMessage: typeof IncomingMessage;
- ipcMain: IpcMain;
- ipcRenderer: IpcRenderer;
- MenuItem: typeof MenuItem;
- Menu: typeof Menu;
- nativeImage: typeof NativeImage;
- nativeTheme: NativeTheme;
- netLog: NetLog;
- net: Net;
- Notification: typeof Notification;
- powerMonitor: PowerMonitor;
- powerSaveBlocker: PowerSaveBlocker;
- protocol: Protocol;
- remote: Remote;
- screen: Screen;
- session: typeof Session;
- shell: Shell;
- systemPreferences: SystemPreferences;
- TouchBarButton: typeof TouchBarButton;
- TouchBarColorPicker: typeof TouchBarColorPicker;
- TouchBarGroup: typeof TouchBarGroup;
- TouchBarLabel: typeof TouchBarLabel;
- TouchBarPopover: typeof TouchBarPopover;
- TouchBarScrubber: typeof TouchBarScrubber;
- TouchBarSegmentedControl: typeof TouchBarSegmentedControl;
- TouchBarSlider: typeof TouchBarSlider;
- TouchBarSpacer: typeof TouchBarSpacer;
- TouchBar: typeof TouchBar;
- Tray: typeof Tray;
- webContents: typeof WebContents;
- webFrame: WebFrame;
- WebRequest: typeof WebRequest;
- webviewTag: WebviewTag;
- }
-
- interface MainInterface extends CommonInterface {
- }
-
- interface RendererInterface extends CommonInterface {
- }
-
- interface AllElectron extends MainInterface, RendererInterface {}
-
- const app: App;
- const autoUpdater: AutoUpdater;
- const clipboard: Clipboard;
- const contentTracing: ContentTracing;
- const crashReporter: CrashReporter;
- const desktopCapturer: DesktopCapturer;
- const dialog: Dialog;
- const globalShortcut: GlobalShortcut;
- const inAppPurchase: InAppPurchase;
- const ipcMain: IpcMain;
- const ipcRenderer: IpcRenderer;
- type nativeImage = NativeImage;
- const nativeImage: typeof NativeImage;
- const nativeTheme: NativeTheme;
- const netLog: NetLog;
- const net: Net;
- const powerMonitor: PowerMonitor;
- const powerSaveBlocker: PowerSaveBlocker;
- const protocol: Protocol;
- const remote: Remote;
- const screen: Screen;
- type session = Session;
- const session: typeof Session;
- const shell: Shell;
- const systemPreferences: SystemPreferences;
- type webContents = WebContents;
- const webContents: typeof WebContents;
- const webFrame: WebFrame;
- const webviewTag: WebviewTag;
-
- interface App extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/app
-
- /**
- * Emitted when Chrome's accessibility support changes. This event fires when
- * assistive technologies, such as screen readers, are enabled or disabled. See
- * https://www.chromium.org/developers/design-documents/accessibility for more
- * details.
- *
- * @platform darwin,win32
- */
- on(event: 'accessibility-support-changed', listener: (event: Event,
- /**
- * `true` when Chrome's accessibility support is enabled, `false` otherwise.
- */
- accessibilitySupportEnabled: boolean) => void): this;
- once(event: 'accessibility-support-changed', listener: (event: Event,
- /**
- * `true` when Chrome's accessibility support is enabled, `false` otherwise.
- */
- accessibilitySupportEnabled: boolean) => void): this;
- addListener(event: 'accessibility-support-changed', listener: (event: Event,
- /**
- * `true` when Chrome's accessibility support is enabled, `false` otherwise.
- */
- accessibilitySupportEnabled: boolean) => void): this;
- removeListener(event: 'accessibility-support-changed', listener: (event: Event,
- /**
- * `true` when Chrome's accessibility support is enabled, `false` otherwise.
- */
- accessibilitySupportEnabled: boolean) => void): this;
- /**
- * Emitted when the application is activated. Various actions can trigger this
- * event, such as launching the application for the first time, attempting to
- * re-launch the application when it's already running, or clicking on the
- * application's dock or taskbar icon.
- *
- * @platform darwin
- */
- on(event: 'activate', listener: (event: Event,
- hasVisibleWindows: boolean) => void): this;
- once(event: 'activate', listener: (event: Event,
- hasVisibleWindows: boolean) => void): this;
- addListener(event: 'activate', listener: (event: Event,
- hasVisibleWindows: boolean) => void): this;
- removeListener(event: 'activate', listener: (event: Event,
- hasVisibleWindows: boolean) => void): this;
- /**
- * Emitted during Handoff after an activity from this device was successfully
- * resumed on another one.
- *
- * @platform darwin
- */
- on(event: 'activity-was-continued', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity.
- */
- userInfo: unknown) => void): this;
- once(event: 'activity-was-continued', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity.
- */
- userInfo: unknown) => void): this;
- addListener(event: 'activity-was-continued', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity.
- */
- userInfo: unknown) => void): this;
- removeListener(event: 'activity-was-continued', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity.
- */
- userInfo: unknown) => void): this;
- /**
- * Emitted before the application starts closing its windows. Calling
- * `event.preventDefault()` will prevent the default behavior, which is terminating
- * the application.
- *
- * **Note:** If application quit was initiated by `autoUpdater.quitAndInstall()`,
- * then `before-quit` is emitted *after* emitting `close` event on all windows and
- * closing them.
- *
- * **Note:** On Windows, this event will not be emitted if the app is closed due to
- * a shutdown/restart of the system or a user logout.
- */
- on(event: 'before-quit', listener: (event: Event) => void): this;
- once(event: 'before-quit', listener: (event: Event) => void): this;
- addListener(event: 'before-quit', listener: (event: Event) => void): this;
- removeListener(event: 'before-quit', listener: (event: Event) => void): this;
- /**
- * Emitted when a browserWindow gets blurred.
- */
- on(event: 'browser-window-blur', listener: (event: Event,
- window: BrowserWindow) => void): this;
- once(event: 'browser-window-blur', listener: (event: Event,
- window: BrowserWindow) => void): this;
- addListener(event: 'browser-window-blur', listener: (event: Event,
- window: BrowserWindow) => void): this;
- removeListener(event: 'browser-window-blur', listener: (event: Event,
- window: BrowserWindow) => void): this;
- /**
- * Emitted when a new browserWindow is created.
- */
- on(event: 'browser-window-created', listener: (event: Event,
- window: BrowserWindow) => void): this;
- once(event: 'browser-window-created', listener: (event: Event,
- window: BrowserWindow) => void): this;
- addListener(event: 'browser-window-created', listener: (event: Event,
- window: BrowserWindow) => void): this;
- removeListener(event: 'browser-window-created', listener: (event: Event,
- window: BrowserWindow) => void): this;
- /**
- * Emitted when a browserWindow gets focused.
- */
- on(event: 'browser-window-focus', listener: (event: Event,
- window: BrowserWindow) => void): this;
- once(event: 'browser-window-focus', listener: (event: Event,
- window: BrowserWindow) => void): this;
- addListener(event: 'browser-window-focus', listener: (event: Event,
- window: BrowserWindow) => void): this;
- removeListener(event: 'browser-window-focus', listener: (event: Event,
- window: BrowserWindow) => void): this;
- /**
- * Emitted when failed to verify the `certificate` for `url`, to trust the
- * certificate you should prevent the default behavior with
- * `event.preventDefault()` and call `callback(true)`.
- */
- on(event: 'certificate-error', listener: (event: Event,
- webContents: WebContents,
- url: string,
- /**
- * The error code
- */
- error: string,
- certificate: Certificate,
- callback: (isTrusted: boolean) => void) => void): this;
- once(event: 'certificate-error', listener: (event: Event,
- webContents: WebContents,
- url: string,
- /**
- * The error code
- */
- error: string,
- certificate: Certificate,
- callback: (isTrusted: boolean) => void) => void): this;
- addListener(event: 'certificate-error', listener: (event: Event,
- webContents: WebContents,
- url: string,
- /**
- * The error code
- */
- error: string,
- certificate: Certificate,
- callback: (isTrusted: boolean) => void) => void): this;
- removeListener(event: 'certificate-error', listener: (event: Event,
- webContents: WebContents,
- url: string,
- /**
- * The error code
- */
- error: string,
- certificate: Certificate,
- callback: (isTrusted: boolean) => void) => void): this;
- /**
- * Emitted during Handoff when an activity from a different device wants to be
- * resumed. You should call `event.preventDefault()` if you want to handle this
- * event.
- *
- * A user activity can be continued only in an app that has the same developer Team
- * ID as the activity's source app and that supports the activity's type. Supported
- * activity types are specified in the app's `Info.plist` under the
- * `NSUserActivityTypes` key.
- *
- * @platform darwin
- */
- on(event: 'continue-activity', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity on another device.
- */
- userInfo: unknown) => void): this;
- once(event: 'continue-activity', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity on another device.
- */
- userInfo: unknown) => void): this;
- addListener(event: 'continue-activity', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity on another device.
- */
- userInfo: unknown) => void): this;
- removeListener(event: 'continue-activity', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity on another device.
- */
- userInfo: unknown) => void): this;
- /**
- * Emitted during Handoff when an activity from a different device fails to be
- * resumed.
- *
- * @platform darwin
- */
- on(event: 'continue-activity-error', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * A string with the error's localized description.
- */
- error: string) => void): this;
- once(event: 'continue-activity-error', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * A string with the error's localized description.
- */
- error: string) => void): this;
- addListener(event: 'continue-activity-error', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * A string with the error's localized description.
- */
- error: string) => void): this;
- removeListener(event: 'continue-activity-error', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * A string with the error's localized description.
- */
- error: string) => void): this;
- /**
- * Emitted when `desktopCapturer.getSources()` is called in the renderer process of
- * `webContents`. Calling `event.preventDefault()` will make it return empty
- * sources.
- */
- on(event: 'desktop-capturer-get-sources', listener: (event: Event,
- webContents: WebContents) => void): this;
- once(event: 'desktop-capturer-get-sources', listener: (event: Event,
- webContents: WebContents) => void): this;
- addListener(event: 'desktop-capturer-get-sources', listener: (event: Event,
- webContents: WebContents) => void): this;
- removeListener(event: 'desktop-capturer-get-sources', listener: (event: Event,
- webContents: WebContents) => void): this;
- /**
- * Emitted whenever there is a GPU info update.
- */
- on(event: 'gpu-info-update', listener: Function): this;
- once(event: 'gpu-info-update', listener: Function): this;
- addListener(event: 'gpu-info-update', listener: Function): this;
- removeListener(event: 'gpu-info-update', listener: Function): this;
- /**
- * Emitted when the GPU process crashes or is killed.
- */
- on(event: 'gpu-process-crashed', listener: (event: Event,
- killed: boolean) => void): this;
- once(event: 'gpu-process-crashed', listener: (event: Event,
- killed: boolean) => void): this;
- addListener(event: 'gpu-process-crashed', listener: (event: Event,
- killed: boolean) => void): this;
- removeListener(event: 'gpu-process-crashed', listener: (event: Event,
- killed: boolean) => void): this;
- /**
- * Emitted when `webContents` wants to do basic auth.
- *
- * The default behavior is to cancel all authentications. To override this you
- * should prevent the default behavior with `event.preventDefault()` and call
- * `callback(username, password)` with the credentials.
- */
- on(event: 'login', listener: (event: Event,
- webContents: WebContents,
- request: Request,
- authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- once(event: 'login', listener: (event: Event,
- webContents: WebContents,
- request: Request,
- authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- addListener(event: 'login', listener: (event: Event,
- webContents: WebContents,
- request: Request,
- authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- removeListener(event: 'login', listener: (event: Event,
- webContents: WebContents,
- request: Request,
- authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- /**
- * Emitted when the user clicks the native macOS new tab button. The new tab button
- * is only visible if the current `BrowserWindow` has a `tabbingIdentifier`
- *
- * @platform darwin
- */
- on(event: 'new-window-for-tab', listener: (event: Event) => void): this;
- once(event: 'new-window-for-tab', listener: (event: Event) => void): this;
- addListener(event: 'new-window-for-tab', listener: (event: Event) => void): this;
- removeListener(event: 'new-window-for-tab', listener: (event: Event) => void): this;
- /**
- * Emitted when the user wants to open a file with the application. The `open-file`
- * event is usually emitted when the application is already open and the OS wants
- * to reuse the application to open the file. `open-file` is also emitted when a
- * file is dropped onto the dock and the application is not yet running. Make sure
- * to listen for the `open-file` event very early in your application startup to
- * handle this case (even before the `ready` event is emitted).
- *
- * You should call `event.preventDefault()` if you want to handle this event.
- *
- * On Windows, you have to parse `process.argv` (in the main process) to get the
- * filepath.
- *
- * @platform darwin
- */
- on(event: 'open-file', listener: (event: Event,
- path: string) => void): this;
- once(event: 'open-file', listener: (event: Event,
- path: string) => void): this;
- addListener(event: 'open-file', listener: (event: Event,
- path: string) => void): this;
- removeListener(event: 'open-file', listener: (event: Event,
- path: string) => void): this;
- /**
- * Emitted when the user wants to open a URL with the application. Your
- * application's `Info.plist` file must define the URL scheme within the
- * `CFBundleURLTypes` key, and set `NSPrincipalClass` to `AtomApplication`.
- *
-You should call `event.preventDefault()` if you want to handle this event.
- *
- * @platform darwin
- */
- on(event: 'open-url', listener: (event: Event,
- url: string) => void): this;
- once(event: 'open-url', listener: (event: Event,
- url: string) => void): this;
- addListener(event: 'open-url', listener: (event: Event,
- url: string) => void): this;
- removeListener(event: 'open-url', listener: (event: Event,
- url: string) => void): this;
- /**
- * Emitted when the application is quitting.
- *
- * **Note:** On Windows, this event will not be emitted if the app is closed due to
- * a shutdown/restart of the system or a user logout.
- */
- on(event: 'quit', listener: (event: Event,
- exitCode: number) => void): this;
- once(event: 'quit', listener: (event: Event,
- exitCode: number) => void): this;
- addListener(event: 'quit', listener: (event: Event,
- exitCode: number) => void): this;
- removeListener(event: 'quit', listener: (event: Event,
- exitCode: number) => void): this;
- /**
- * Emitted when Electron has finished initializing. On macOS, `launchInfo` holds
- * the `userInfo` of the `NSUserNotification` that was used to open the
- * application, if it was launched from Notification Center. You can call
- * `app.isReady()` to check if this event has already fired.
- */
- on(event: 'ready', listener: (launchInfo: unknown) => void): this;
- once(event: 'ready', listener: (launchInfo: unknown) => void): this;
- addListener(event: 'ready', listener: (launchInfo: unknown) => void): this;
- removeListener(event: 'ready', listener: (launchInfo: unknown) => void): this;
- /**
- * Emitted when `remote.getBuiltin()` is called in the renderer process of
- * `webContents`. Calling `event.preventDefault()` will prevent the module from
- * being returned. Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-builtin', listener: (event: Event,
- webContents: WebContents,
- moduleName: string) => void): this;
- once(event: 'remote-get-builtin', listener: (event: Event,
- webContents: WebContents,
- moduleName: string) => void): this;
- addListener(event: 'remote-get-builtin', listener: (event: Event,
- webContents: WebContents,
- moduleName: string) => void): this;
- removeListener(event: 'remote-get-builtin', listener: (event: Event,
- webContents: WebContents,
- moduleName: string) => void): this;
- /**
- * Emitted when `remote.getCurrentWebContents()` is called in the renderer process
- * of `webContents`. Calling `event.preventDefault()` will prevent the object from
- * being returned. Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-current-web-contents', listener: (event: Event,
- webContents: WebContents) => void): this;
- once(event: 'remote-get-current-web-contents', listener: (event: Event,
- webContents: WebContents) => void): this;
- addListener(event: 'remote-get-current-web-contents', listener: (event: Event,
- webContents: WebContents) => void): this;
- removeListener(event: 'remote-get-current-web-contents', listener: (event: Event,
- webContents: WebContents) => void): this;
- /**
- * Emitted when `remote.getCurrentWindow()` is called in the renderer process of
- * `webContents`. Calling `event.preventDefault()` will prevent the object from
- * being returned. Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-current-window', listener: (event: Event,
- webContents: WebContents) => void): this;
- once(event: 'remote-get-current-window', listener: (event: Event,
- webContents: WebContents) => void): this;
- addListener(event: 'remote-get-current-window', listener: (event: Event,
- webContents: WebContents) => void): this;
- removeListener(event: 'remote-get-current-window', listener: (event: Event,
- webContents: WebContents) => void): this;
- /**
- * Emitted when `remote.getGlobal()` is called in the renderer process of
- * `webContents`. Calling `event.preventDefault()` will prevent the global from
- * being returned. Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-global', listener: (event: Event,
- webContents: WebContents,
- globalName: string) => void): this;
- once(event: 'remote-get-global', listener: (event: Event,
- webContents: WebContents,
- globalName: string) => void): this;
- addListener(event: 'remote-get-global', listener: (event: Event,
- webContents: WebContents,
- globalName: string) => void): this;
- removeListener(event: 'remote-get-global', listener: (event: Event,
- webContents: WebContents,
- globalName: string) => void): this;
- /**
- * Emitted when `.getWebContents()` is called in the renderer process of
- * `webContents`. Calling `event.preventDefault()` will prevent the object from
- * being returned. Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-guest-web-contents', listener: (event: Event,
- webContents: WebContents,
- guestWebContents: WebContents) => void): this;
- once(event: 'remote-get-guest-web-contents', listener: (event: Event,
- webContents: WebContents,
- guestWebContents: WebContents) => void): this;
- addListener(event: 'remote-get-guest-web-contents', listener: (event: Event,
- webContents: WebContents,
- guestWebContents: WebContents) => void): this;
- removeListener(event: 'remote-get-guest-web-contents', listener: (event: Event,
- webContents: WebContents,
- guestWebContents: WebContents) => void): this;
- /**
- * Emitted when `remote.require()` is called in the renderer process of
- * `webContents`. Calling `event.preventDefault()` will prevent the module from
- * being returned. Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-require', listener: (event: Event,
- webContents: WebContents,
- moduleName: string) => void): this;
- once(event: 'remote-require', listener: (event: Event,
- webContents: WebContents,
- moduleName: string) => void): this;
- addListener(event: 'remote-require', listener: (event: Event,
- webContents: WebContents,
- moduleName: string) => void): this;
- removeListener(event: 'remote-require', listener: (event: Event,
- webContents: WebContents,
- moduleName: string) => void): this;
- /**
- * Emitted when the renderer process of `webContents` crashes or is killed.
- */
- on(event: 'renderer-process-crashed', listener: (event: Event,
- webContents: WebContents,
- killed: boolean) => void): this;
- once(event: 'renderer-process-crashed', listener: (event: Event,
- webContents: WebContents,
- killed: boolean) => void): this;
- addListener(event: 'renderer-process-crashed', listener: (event: Event,
- webContents: WebContents,
- killed: boolean) => void): this;
- removeListener(event: 'renderer-process-crashed', listener: (event: Event,
- webContents: WebContents,
- killed: boolean) => void): this;
- /**
- * This event will be emitted inside the primary instance of your application when
- * a second instance has been executed and calls `app.requestSingleInstanceLock()`.
- *
- * `argv` is an Array of the second instance's command line arguments, and
- * `workingDirectory` is its current working directory. Usually applications
- * respond to this by making their primary window focused and non-minimized.
- *
- * This event is guaranteed to be emitted after the `ready` event of `app` gets
- * emitted.
- *
- * **Note:** Extra command line arguments might be added by Chromium, such as
- * `--original-process-start-time`.
- */
- on(event: 'second-instance', listener: (event: Event,
- /**
- * An array of the second instance's command line arguments
- */
- argv: string[],
- /**
- * The second instance's working directory
- */
- workingDirectory: string) => void): this;
- once(event: 'second-instance', listener: (event: Event,
- /**
- * An array of the second instance's command line arguments
- */
- argv: string[],
- /**
- * The second instance's working directory
- */
- workingDirectory: string) => void): this;
- addListener(event: 'second-instance', listener: (event: Event,
- /**
- * An array of the second instance's command line arguments
- */
- argv: string[],
- /**
- * The second instance's working directory
- */
- workingDirectory: string) => void): this;
- removeListener(event: 'second-instance', listener: (event: Event,
- /**
- * An array of the second instance's command line arguments
- */
- argv: string[],
- /**
- * The second instance's working directory
- */
- workingDirectory: string) => void): this;
- /**
- * Emitted when a client certificate is requested.
- *
- * The `url` corresponds to the navigation entry requesting the client certificate
- * and `callback` can be called with an entry filtered from the list. Using
- * `event.preventDefault()` prevents the application from using the first
- * certificate from the store.
- */
- on(event: 'select-client-certificate', listener: (event: Event,
- webContents: WebContents,
- url: string,
- certificateList: Certificate[],
- callback: (certificate?: Certificate) => void) => void): this;
- once(event: 'select-client-certificate', listener: (event: Event,
- webContents: WebContents,
- url: string,
- certificateList: Certificate[],
- callback: (certificate?: Certificate) => void) => void): this;
- addListener(event: 'select-client-certificate', listener: (event: Event,
- webContents: WebContents,
- url: string,
- certificateList: Certificate[],
- callback: (certificate?: Certificate) => void) => void): this;
- removeListener(event: 'select-client-certificate', listener: (event: Event,
- webContents: WebContents,
- url: string,
- certificateList: Certificate[],
- callback: (certificate?: Certificate) => void) => void): this;
- /**
- * Emitted when Electron has created a new `session`.
- */
- on(event: 'session-created', listener: (session: Session) => void): this;
- once(event: 'session-created', listener: (session: Session) => void): this;
- addListener(event: 'session-created', listener: (session: Session) => void): this;
- removeListener(event: 'session-created', listener: (session: Session) => void): this;
- /**
- * Emitted when Handoff is about to be resumed on another device. If you need to
- * update the state to be transferred, you should call `event.preventDefault()`
- * immediately, construct a new `userInfo` dictionary and call
- * `app.updateCurrentActiviy()` in a timely manner. Otherwise, the operation will
- * fail and `continue-activity-error` will be called.
- *
- * @platform darwin
- */
- on(event: 'update-activity-state', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity.
- */
- userInfo: unknown) => void): this;
- once(event: 'update-activity-state', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity.
- */
- userInfo: unknown) => void): this;
- addListener(event: 'update-activity-state', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity.
- */
- userInfo: unknown) => void): this;
- removeListener(event: 'update-activity-state', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string,
- /**
- * Contains app-specific state stored by the activity.
- */
- userInfo: unknown) => void): this;
- /**
- * Emitted when a new webContents is created.
- */
- on(event: 'web-contents-created', listener: (event: Event,
- webContents: WebContents) => void): this;
- once(event: 'web-contents-created', listener: (event: Event,
- webContents: WebContents) => void): this;
- addListener(event: 'web-contents-created', listener: (event: Event,
- webContents: WebContents) => void): this;
- removeListener(event: 'web-contents-created', listener: (event: Event,
- webContents: WebContents) => void): this;
- /**
- * Emitted when there is a problem with the Widevine installation that cannot be
- * automatically handled. If there are no handlers registered for this event it
- * will show a dialog with the error and terminate the application when it is
- * dismissed. If this is not the desired behaviour a handler needs to be registered
- * to provide customized behaviour. This event is always emitted after the `ready`
- * event.
- */
- on(event: 'widevine-error', listener: (
- /**
- * An `Error` instance indicating what went wrong during the Widevine CDM
- * installation.
- */
- error: Error) => void): this;
- once(event: 'widevine-error', listener: (
- /**
- * An `Error` instance indicating what went wrong during the Widevine CDM
- * installation.
- */
- error: Error) => void): this;
- addListener(event: 'widevine-error', listener: (
- /**
- * An `Error` instance indicating what went wrong during the Widevine CDM
- * installation.
- */
- error: Error) => void): this;
- removeListener(event: 'widevine-error', listener: (
- /**
- * An `Error` instance indicating what went wrong during the Widevine CDM
- * installation.
- */
- error: Error) => void): this;
- /**
- * Emitted once Widevine has been properly installed/updated/registered and is
- * ready to use to be used. Trying to play back protected content prior to the
- * reception of this event will cause errors. This event is always emitted after
- * the `ready` event.
- */
- on(event: 'widevine-ready', listener: (
- /**
- * A string indicating the version of the Widevine CDM in use.
- */
- version: string,
- /**
- * If a pending update was applied, contains a string indicating the last CDM
- * version, otherwise `null`.
- */
- lastVersion: string) => void): this;
- once(event: 'widevine-ready', listener: (
- /**
- * A string indicating the version of the Widevine CDM in use.
- */
- version: string,
- /**
- * If a pending update was applied, contains a string indicating the last CDM
- * version, otherwise `null`.
- */
- lastVersion: string) => void): this;
- addListener(event: 'widevine-ready', listener: (
- /**
- * A string indicating the version of the Widevine CDM in use.
- */
- version: string,
- /**
- * If a pending update was applied, contains a string indicating the last CDM
- * version, otherwise `null`.
- */
- lastVersion: string) => void): this;
- removeListener(event: 'widevine-ready', listener: (
- /**
- * A string indicating the version of the Widevine CDM in use.
- */
- version: string,
- /**
- * If a pending update was applied, contains a string indicating the last CDM
- * version, otherwise `null`.
- */
- lastVersion: string) => void): this;
- /**
- * Emitted when there is a Widevine update available that is pending installation.
- * This event is always emitted after the `ready` event. Once the application is
- * restarted the update will be automatically applied and a `widevine-ready`-event
- * emitted, as usual.
- */
- on(event: 'widevine-update-pending', listener: (
- /**
- * A string indicating the version of the Widevine CDM in use.
- */
- currentVersion: string,
- /**
- * A string indicating the version of the Widevine CDM pending installation.
- */
- pendingVersion: string) => void): this;
- once(event: 'widevine-update-pending', listener: (
- /**
- * A string indicating the version of the Widevine CDM in use.
- */
- currentVersion: string,
- /**
- * A string indicating the version of the Widevine CDM pending installation.
- */
- pendingVersion: string) => void): this;
- addListener(event: 'widevine-update-pending', listener: (
- /**
- * A string indicating the version of the Widevine CDM in use.
- */
- currentVersion: string,
- /**
- * A string indicating the version of the Widevine CDM pending installation.
- */
- pendingVersion: string) => void): this;
- removeListener(event: 'widevine-update-pending', listener: (
- /**
- * A string indicating the version of the Widevine CDM in use.
- */
- currentVersion: string,
- /**
- * A string indicating the version of the Widevine CDM pending installation.
- */
- pendingVersion: string) => void): this;
- /**
- * Emitted during Handoff before an activity from a different device wants to be
- * resumed. You should call `event.preventDefault()` if you want to handle this
- * event.
- *
- * @platform darwin
- */
- on(event: 'will-continue-activity', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string) => void): this;
- once(event: 'will-continue-activity', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string) => void): this;
- addListener(event: 'will-continue-activity', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string) => void): this;
- removeListener(event: 'will-continue-activity', listener: (event: Event,
- /**
- * A string identifying the activity. Maps to `NSUserActivity.activityType`.
- */
- type: string) => void): this;
- /**
- * Emitted when the application has finished basic startup. On Windows and Linux,
- * the `will-finish-launching` event is the same as the `ready` event; on macOS,
- * this event represents the `applicationWillFinishLaunching` notification of
- * `NSApplication`. You would usually set up listeners for the `open-file` and
- * `open-url` events here, and start the crash reporter and auto updater.
- *
-In most cases, you should do everything in the `ready` event handler.
- */
- on(event: 'will-finish-launching', listener: Function): this;
- once(event: 'will-finish-launching', listener: Function): this;
- addListener(event: 'will-finish-launching', listener: Function): this;
- removeListener(event: 'will-finish-launching', listener: Function): this;
- /**
- * Emitted when all windows have been closed and the application will quit. Calling
- * `event.preventDefault()` will prevent the default behaviour, which is
- * terminating the application.
- *
- * See the description of the `window-all-closed` event for the differences between
- * the `will-quit` and `window-all-closed` events.
- *
- * **Note:** On Windows, this event will not be emitted if the app is closed due to
- * a shutdown/restart of the system or a user logout.
- */
- on(event: 'will-quit', listener: (event: Event) => void): this;
- once(event: 'will-quit', listener: (event: Event) => void): this;
- addListener(event: 'will-quit', listener: (event: Event) => void): this;
- removeListener(event: 'will-quit', listener: (event: Event) => void): this;
- /**
- * Emitted when all windows have been closed.
- *
- * If you do not subscribe to this event and all windows are closed, the default
- * behavior is to quit the app; however, if you subscribe, you control whether the
- * app quits or not. If the user pressed `Cmd + Q`, or the developer called
- * `app.quit()`, Electron will first try to close all the windows and then emit the
- * `will-quit` event, and in this case the `window-all-closed` event would not be
- * emitted.
- */
- on(event: 'window-all-closed', listener: Function): this;
- once(event: 'window-all-closed', listener: Function): this;
- addListener(event: 'window-all-closed', listener: Function): this;
- removeListener(event: 'window-all-closed', listener: Function): this;
- /**
- * Adds `path` to the recent documents list.
- *
- * This list is managed by the OS. On Windows, you can visit the list from the task
- * bar, and on macOS, you can visit it from dock menu.
- *
- * @platform darwin,win32
- */
- addRecentDocument(path: string): void;
- /**
- * Clears the recent documents list.
- *
- * @platform darwin,win32
- */
- clearRecentDocuments(): void;
- /**
- * By default, Chromium disables 3D APIs (e.g. WebGL) until restart on a per domain
- * basis if the GPU processes crashes too frequently. This function disables that
- * behaviour.
-
-This method can only be called before app is ready.
- */
- disableDomainBlockingFor3DAPIs(): void;
- /**
- * Disables hardware acceleration for current app.
- *
-This method can only be called before app is ready.
- */
- disableHardwareAcceleration(): void;
- /**
- * Enables full sandbox mode on the app.
- *
-This method can only be called before app is ready.
- *
- * @experimental
- */
- enableSandbox(): void;
- /**
- * Exits immediately with `exitCode`. `exitCode` defaults to 0.
- *
- * All windows will be closed immediately without asking the user, and the
- * `before-quit` and `will-quit` events will not be emitted.
- */
- exit(exitCode?: number): void;
- /**
- * On Linux, focuses on the first visible window. On macOS, makes the application
- * the active app. On Windows, focuses on the application's first window.
- */
- focus(): void;
- /**
- * Array of `ProcessMetric` objects that correspond to memory and CPU usage
- * statistics of all the processes associated with the app.
- */
- getAppMetrics(): ProcessMetric[];
- /**
- * The current application directory.
- */
- getAppPath(): string;
- /**
- * The current value displayed in the counter badge.
-
-**Deprecated**
- *
- * @platform linux,darwin
- */
- getBadgeCount(): number;
- /**
- * The type of the currently running activity.
- *
- * @platform darwin
- */
- getCurrentActivityType(): string;
- /**
- * fulfilled with the app's icon, which is a NativeImage.
- *
- * Fetches a path's associated icon.
- *
- * On _Windows_, there a 2 kinds of icons:
- *
- * * Icons associated with certain file extensions, like `.mp3`, `.png`, etc.
- * * Icons inside the file itself, like `.exe`, `.dll`, `.ico`.
- *
- * On _Linux_ and _macOS_, icons depend on the application associated with file
- * mime type.
- */
- getFileIcon(path: string, options?: FileIconOptions): Promise;
- /**
- * The Graphics Feature Status from `chrome://gpu/`.
- *
- * **Note:** This information is only usable after the `gpu-info-update` event is
- * emitted.
- */
- getGPUFeatureStatus(): GPUFeatureStatus;
- /**
- * For `infoType` equal to `complete`: Promise is fulfilled with `Object`
- * containing all the GPU Information as in chromium's GPUInfo object. This
- * includes the version and driver information that's shown on `chrome://gpu` page.
- *
- * For `infoType` equal to `basic`: Promise is fulfilled with `Object` containing
- * fewer attributes than when requested with `complete`. Here's an example of basic
- * response:
- *
- * Using `basic` should be preferred if only basic information like `vendorId` or
- * `driverId` is needed.
- */
- getGPUInfo(infoType: 'basic' | 'complete'): Promise;
- /**
- * * `minItems` Integer - The minimum number of items that will be shown in the
- * Jump List (for a more detailed description of this value see the MSDN docs).
- * * `removedItems` JumpListItem[] - Array of `JumpListItem` objects that
- * correspond to items that the user has explicitly removed from custom categories
- * in the Jump List. These items must not be re-added to the Jump List in the
- * **next** call to `app.setJumpList()`, Windows will not display any custom
- * category that contains any of the removed items.
- *
- * @platform win32
- */
- getJumpListSettings(): JumpListSettings;
- /**
- * The current application locale. Possible return values are documented here.
- *
- * To set the locale, you'll want to use a command line switch at app startup,
- * which may be found here.
- *
- * **Note:** When distributing your packaged app, you have to also ship the
- * `locales` folder.
- *
- * **Note:** On Windows, you have to call it after the `ready` events gets emitted.
- */
- getLocale(): string;
- /**
- * User operating system's locale two-letter ISO 3166 country code. The value is
- * taken from native OS APIs.
- *
-**Note:** When unable to detect locale country code, it returns empty string.
- */
- getLocaleCountryCode(): string;
- /**
- * If you provided `path` and `args` options to `app.setLoginItemSettings`, then
- * you need to pass the same arguments here for `openAtLogin` to be set correctly.
- *
- *
- * * `openAtLogin` Boolean - `true` if the app is set to open at login.
- * * `openAsHidden` Boolean _macOS_ - `true` if the app is set to open as hidden at
- * login. This setting is not available on MAS builds.
- * * `wasOpenedAtLogin` Boolean _macOS_ - `true` if the app was opened at login
- * automatically. This setting is not available on MAS builds.
- * * `wasOpenedAsHidden` Boolean _macOS_ - `true` if the app was opened as a hidden
- * login item. This indicates that the app should not open any windows at startup.
- * This setting is not available on MAS builds.
- * * `restoreState` Boolean _macOS_ - `true` if the app was opened as a login item
- * that should restore the state from the previous session. This indicates that the
- * app should restore the windows that were open the last time the app was closed.
- * This setting is not available on MAS builds.
- *
- * @platform darwin,win32
- */
- getLoginItemSettings(options?: LoginItemSettingsOptions): LoginItemSettings;
- /**
- * The current application's name, which is the name in the application's
- * `package.json` file.
- *
- * Usually the `name` field of `package.json` is a short lowercase name, according
- * to the npm modules spec. You should usually also specify a `productName` field,
- * which is your application's full capitalized name, and which will be preferred
- * over `name` by Electron.
-
-**Deprecated**
- */
- getName(): string;
- /**
- * A path to a special directory or file associated with `name`. On failure, an
- * `Error` is thrown.
- *
- * If `app.getPath('logs')` is called without called `app.setAppLogsPath()` being
- * called first, a default log directory will be created equivalent to calling
- * `app.setAppLogsPath()` without a `path` parameter.
- */
- getPath(name: 'home' | 'appData' | 'userData' | 'cache' | 'temp' | 'exe' | 'module' | 'desktop' | 'documents' | 'downloads' | 'music' | 'pictures' | 'videos' | 'logs' | 'pepperFlashSystemPlugin'): string;
- /**
- * The version of the loaded application. If no version is found in the
- * application's `package.json` file, the version of the current bundle or
- * executable is returned.
- */
- getVersion(): string;
- /**
- * This method returns whether or not this instance of your app is currently
- * holding the single instance lock. You can request the lock with
- * `app.requestSingleInstanceLock()` and release with
- * `app.releaseSingleInstanceLock()`
- */
- hasSingleInstanceLock(): boolean;
- /**
- * Hides all application windows without minimizing them.
- *
- * @platform darwin
- */
- hide(): void;
- /**
- * Imports the certificate in pkcs12 format into the platform certificate store.
- * `callback` is called with the `result` of import operation, a value of `0`
- * indicates success while any other value indicates failure according to Chromium
- * net_error_list.
- *
- * @platform linux
- */
- importCertificate(options: ImportCertificateOptions, callback: (result: number) => void): void;
- /**
- * Invalidates the current Handoff user activity.
- *
- * @platform darwin
- */
- invalidateCurrentActivity(): void;
- /**
- * `true` if Chrome's accessibility support is enabled, `false` otherwise. This API
- * will return `true` if the use of assistive technologies, such as screen readers,
- * has been detected. See
- * https://www.chromium.org/developers/design-documents/accessibility for more
- * details.
-
-**Deprecated**
- *
- * @platform darwin,win32
- */
- isAccessibilitySupportEnabled(): boolean;
- /**
- * This method checks if the current executable is the default handler for a
- * protocol (aka URI scheme). If so, it will return true. Otherwise, it will return
- * false.
- *
- * **Note:** On macOS, you can use this method to check if the app has been
- * registered as the default protocol handler for a protocol. You can also verify
- * this by checking `~/Library/Preferences/com.apple.LaunchServices.plist` on the
- * macOS machine. Please refer to Apple's documentation for details.
- *
- * The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme
- * internally.
- */
- isDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean;
- /**
- * whether or not the current OS version allows for native emoji pickers.
- */
- isEmojiPanelSupported(): boolean;
- /**
- * Whether the application is currently running from the systems Application
- * folder. Use in combination with `app.moveToApplicationsFolder()`
- *
- * @platform darwin
- */
- isInApplicationsFolder(): boolean;
- /**
- * `true` if Electron has finished initializing, `false` otherwise.
- */
- isReady(): boolean;
- /**
- * Whether the current desktop environment is Unity launcher.
- *
- * @platform linux
- */
- isUnityRunning(): boolean;
- /**
- * Whether the move was successful. Please note that if the move is successful,
- * your application will quit and relaunch.
- *
- * No confirmation dialog will be presented by default. If you wish to allow the
- * user to confirm the operation, you may do so using the `dialog` API.
- *
- * **NOTE:** This method throws errors if anything other than the user causes the
- * move to fail. For instance if the user cancels the authorization dialog, this
- * method returns false. If we fail to perform the copy, then this method will
- * throw an error. The message in the error should be informative and tell you
- * exactly what went wrong.
- *
- * By default, if an app of the same name as the one being moved exists in the
- * Applications directory and is _not_ running, the existing app will be trashed
- * and the active app moved into its place. If it _is_ running, the pre-existing
- * running app will assume focus and the the previously active app will quit
- * itself. This behavior can be changed by providing the optional conflict handler,
- * where the boolean returned by the handler determines whether or not the move
- * conflict is resolved with default behavior. i.e. returning `false` will ensure
- * no further action is taken, returning `true` will result in the default behavior
- * and the method continuing.
- *
- * For example:
- *
- * Would mean that if an app already exists in the user directory, if the user
- * chooses to 'Continue Move' then the function would continue with its default
- * behavior and the existing app will be trashed and the active app moved into its
- * place.
- *
- * @platform darwin
- */
- moveToApplicationsFolder(options?: MoveToApplicationsFolderOptions): boolean;
- /**
- * Try to close all windows. The `before-quit` event will be emitted first. If all
- * windows are successfully closed, the `will-quit` event will be emitted and by
- * default the application will terminate.
- *
- * This method guarantees that all `beforeunload` and `unload` event handlers are
- * correctly executed. It is possible that a window cancels the quitting by
- * returning `false` in the `beforeunload` event handler.
- */
- quit(): void;
- /**
- * Relaunches the app when current instance exits.
- *
- * By default, the new instance will use the same working directory and command
- * line arguments with current instance. When `args` is specified, the `args` will
- * be passed as command line arguments instead. When `execPath` is specified, the
- * `execPath` will be executed for relaunch instead of current app.
- *
- * Note that this method does not quit the app when executed, you have to call
- * `app.quit` or `app.exit` after calling `app.relaunch` to make the app restart.
- *
- * When `app.relaunch` is called for multiple times, multiple instances will be
- * started after current instance exited.
- *
- * An example of restarting current instance immediately and adding a new command
- * line argument to the new instance:
- */
- relaunch(options?: RelaunchOptions): void;
- /**
- * Releases all locks that were created by `requestSingleInstanceLock`. This will
- * allow multiple instances of the application to once again run side by side.
- */
- releaseSingleInstanceLock(): void;
- /**
- * Whether the call succeeded.
- *
- * This method checks if the current executable as the default handler for a
- * protocol (aka URI scheme). If so, it will remove the app as the default handler.
- *
- * @platform darwin,win32
- */
- removeAsDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean;
- /**
- * The return value of this method indicates whether or not this instance of your
- * application successfully obtained the lock. If it failed to obtain the lock,
- * you can assume that another instance of your application is already running with
- * the lock and exit immediately.
- *
- * I.e. This method returns `true` if your process is the primary instance of your
- * application and your app should continue loading. It returns `false` if your
- * process should immediately quit as it has sent its parameters to another
- * instance that has already acquired the lock.
- *
- * On macOS, the system enforces single instance automatically when users try to
- * open a second instance of your app in Finder, and the `open-file` and `open-url`
- * events will be emitted for that. However when users start your app in command
- * line, the system's single instance mechanism will be bypassed, and you have to
- * use this method to ensure single instance.
- *
- * An example of activating the window of primary instance when a second instance
- * starts:
- */
- requestSingleInstanceLock(): boolean;
- /**
- * Marks the current Handoff user activity as inactive without invalidating it.
- *
- * @platform darwin
- */
- resignCurrentActivity(): void;
- /**
- * Set the about panel options. This will override the values defined in the app's
- * `.plist` file on MacOS. See the Apple docs for more details. On Linux, values
- * must be set in order to be shown; there are no defaults.
- *
- * @platform darwin,linux
- */
- setAboutPanelOptions(options: AboutPanelOptionsOptions): void;
- /**
- * Manually enables Chrome's accessibility support, allowing to expose
- * accessibility switch to users in application settings. See Chromium's
- * accessibility docs for more details. Disabled by default.
- *
- * This API must be called after the `ready` event is emitted.
- *
- * **Note:** Rendering accessibility tree can significantly affect the performance
- * of your app. It should not be enabled by default.
-
-**Deprecated**
- *
- * @platform darwin,win32
- */
- setAccessibilitySupportEnabled(enabled: boolean): void;
- /**
- * Sets or creates a directory your app's logs which can then be manipulated with
- * `app.getPath()` or `app.setPath(pathName, newPath)`.
- *
- * Calling `app.setAppLogsPath()` without a `path` parameter will result in this
- * directory being set to `~/Library/Logs/YourAppName` on _macOS_, and inside the
- * `userData` directory on _Linux_ and _Windows_.
- */
- setAppLogsPath(path?: string): void;
- /**
- * Changes the Application User Model ID to `id`.
- *
- * @platform win32
- */
- setAppUserModelId(id: string): void;
- /**
- * Whether the call succeeded.
- *
- * This method sets the current executable as the default handler for a protocol
- * (aka URI scheme). It allows you to integrate your app deeper into the operating
- * system. Once registered, all links with `your-protocol://` will be opened with
- * the current executable. The whole link, including protocol, will be passed to
- * your application as a parameter.
- *
- * On Windows, you can provide optional parameters path, the path to your
- * executable, and args, an array of arguments to be passed to your executable when
- * it launches.
- *
- * **Note:** On macOS, you can only register protocols that have been added to your
- * app's `info.plist`, which can not be modified at runtime. You can however change
- * the file with a simple text editor or script during build time. Please refer to
- * Apple's documentation for details.
- *
- * **Note:** In a Windows Store environment (when packaged as an `appx`) this API
- * will return `true` for all calls but the registry key it sets won't be
- * accessible by other applications. In order to register your Windows Store
- * application as a default protocol handler you must declare the protocol in your
- * manifest.
- *
- * The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme
- * internally.
- */
- setAsDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean;
- /**
- * Whether the call succeeded.
- *
- * Sets the counter badge for current app. Setting the count to `0` will hide the
- * badge.
- *
- * On macOS, it shows on the dock icon. On Linux, it only works for Unity launcher.
- *
- * **Note:** Unity launcher requires the existence of a `.desktop` file to work,
- * for more information please read Desktop Environment Integration.
- *
-**Deprecated**
- *
- * @platform linux,darwin
- */
- setBadgeCount(count: number): boolean;
- /**
- * Sets or removes a custom Jump List for the application, and returns one of the
- * following strings:
- *
- * * `ok` - Nothing went wrong.
- * * `error` - One or more errors occurred, enable runtime logging to figure out
- * the likely cause.
- * * `invalidSeparatorError` - An attempt was made to add a separator to a custom
- * category in the Jump List. Separators are only allowed in the standard `Tasks`
- * category.
- * * `fileTypeRegistrationError` - An attempt was made to add a file link to the
- * Jump List for a file type the app isn't registered to handle.
- * * `customCategoryAccessDeniedError` - Custom categories can't be added to the
- * Jump List due to user privacy or group policy settings.
- *
- * If `categories` is `null` the previously set custom Jump List (if any) will be
- * replaced by the standard Jump List for the app (managed by Windows).
- *
- * **Note:** If a `JumpListCategory` object has neither the `type` nor the `name`
- * property set then its `type` is assumed to be `tasks`. If the `name` property is
- * set but the `type` property is omitted then the `type` is assumed to be
- * `custom`.
- *
- * **Note:** Users can remove items from custom categories, and Windows will not
- * allow a removed item to be added back into a custom category until **after** the
- * next successful call to `app.setJumpList(categories)`. Any attempt to re-add a
- * removed item to a custom category earlier than that will result in the entire
- * custom category being omitted from the Jump List. The list of removed items can
- * be obtained using `app.getJumpListSettings()`.
- *
-Here's a very simple example of creating a custom Jump List:
- *
- * @platform win32
- */
- setJumpList(categories: (JumpListCategory[]) | (null)): void;
- /**
- * Set the app's login item settings.
- *
- * To work with Electron's `autoUpdater` on Windows, which uses Squirrel, you'll
- * want to set the launch path to Update.exe, and pass arguments that specify your
- * application name. For example:
- *
- * @platform darwin,win32
- */
- setLoginItemSettings(settings: Settings): void;
- /**
- * Overrides the current application's name.
-
-**Deprecated**
- */
- setName(name: string): void;
- /**
- * Overrides the `path` to a special directory or file associated with `name`. If
- * the path specifies a directory that does not exist, an `Error` is thrown. In
- * that case, the directory should be created with `fs.mkdirSync` or similar.
- *
- * You can only override paths of a `name` defined in `app.getPath`.
- *
- * By default, web pages' cookies and caches will be stored under the `userData`
- * directory. If you want to change this location, you have to override the
- * `userData` path before the `ready` event of the `app` module is emitted.
- */
- setPath(name: string, path: string): void;
- /**
- * Creates an `NSUserActivity` and sets it as the current activity. The activity is
- * eligible for Handoff to another device afterward.
- *
- * @platform darwin
- */
- setUserActivity(type: string, userInfo: any, webpageURL?: string): void;
- /**
- * Adds `tasks` to the Tasks category of the Jump List on Windows.
- *
- * `tasks` is an array of `Task` objects.
- *
- * Whether the call succeeded.
- *
- * **Note:** If you'd like to customize the Jump List even more use
- * `app.setJumpList(categories)` instead.
- *
- * @platform win32
- */
- setUserTasks(tasks: Task[]): boolean;
- /**
- * Shows application windows after they were hidden. Does not automatically focus
- * them.
- *
- * @platform darwin
- */
- show(): void;
- /**
- * Show the app's about panel options. These options can be overridden with
- * `app.setAboutPanelOptions(options)`.
- *
- * @platform darwin,linux
- */
- showAboutPanel(): void;
- /**
- * Show the platform's native emoji picker.
- *
- * @platform darwin,win32
- */
- showEmojiPanel(): void;
- /**
- * This function **must** be called once you have finished accessing the security
- * scoped file. If you do not remember to stop accessing the bookmark, kernel
- * resources will be leaked and your app will lose its ability to reach outside the
- * sandbox completely, until your app is restarted.
- *
- * Start accessing a security scoped resource. With this method Electron
- * applications that are packaged for the Mac App Store may reach outside their
- * sandbox to access files chosen by the user. See Apple's documentation for a
- * description of how this system works.
- *
- * @platform mas
- */
- startAccessingSecurityScopedResource(bookmarkData: string): Function;
- /**
- * Updates the current activity if its type matches `type`, merging the entries
- * from `userInfo` into its current `userInfo` dictionary.
- *
- * @platform darwin
- */
- updateCurrentActivity(type: string, userInfo: any): void;
- /**
- * Initiates asynchronous Widevine CDM verify/install/update procedure and returns
- * no value. Once initiated Widevine related events will be emitted as necessary,
- * namely `widevine-ready`, `widevine-update-pending` & `widevine-error`. Unless
- * the `no-verify-widevine-cdm` command line parameter is set this API is
- * automatically called on startup and should not be called manually. If customized
- * options are necessary for some reason `no-verify-widevine-cdm` should be set and
- * the API call made once (with the custom options), very early, after the app has
- * received the `ready` event (but before loading any media-related content to
- * avoid potentially requiring a restart if CDM installation is necessary).
- */
- verifyWidevineCdm(options?: VerifyWidevineCdmOptions): void;
- /**
- * fulfilled when Electron is initialized. May be used as a convenient alternative
- * to checking `app.isReady()` and subscribing to the `ready` event if the app is
- * not ready yet.
- */
- whenReady(): Promise;
- /**
- * A `Boolean` property that's `true` if Chrome's accessibility support is enabled,
- * `false` otherwise. This property will be `true` if the use of assistive
- * technologies, such as screen readers, has been detected. Setting this property
- * to `true` manually enables Chrome's accessibility support, allowing developers
- * to expose accessibility switch to users in application settings.
- *
- * See Chromium's accessibility docs for more details. Disabled by default.
- *
- * This API must be called after the `ready` event is emitted.
- *
- * **Note:** Rendering accessibility tree can significantly affect the performance
- * of your app. It should not be enabled by default.
- *
- * @platform darwin,win32
- */
- accessibilitySupportEnabled: boolean;
- /**
- * A `Boolean` which when `true` disables the overrides that Electron has in place
- * to ensure renderer processes are restarted on every navigation. The current
- * default value for this property is `false`.
- *
- * The intention is for these overrides to become disabled by default and then at
- * some point in the future this property will be removed. This property impacts
- * which native modules you can use in the renderer process. For more information
- * on the direction Electron is going with renderer process restarts and usage of
- * native modules in the renderer process please check out this Tracking Issue.
- */
- allowRendererProcessReuse: boolean;
- /**
- * A `Menu | null` property that returns `Menu` if one has been set and `null`
- * otherwise. Users can pass a Menu to set this property.
- */
- applicationMenu: (Menu) | (null);
- /**
- * An `Integer` property that returns the badge count for current app. Setting the
- * count to `0` will hide the badge.
- *
- * On macOS, setting this with any nonzero integer shows on the dock icon. On
- * Linux, this property only works for Unity launcher.
- *
- * **Note:** Unity launcher requires the existence of a `.desktop` file to work,
- * for more information please read Desktop Environment Integration.
- *
- * @platform linux,darwin
- */
- badgeCount: number;
- /**
- * A `CommandLine` object that allows you to read and manipulate the command line
- * arguments that Chromium uses.
- *
- */
- readonly commandLine: CommandLine;
- /**
- * A `Dock` object that allows you to perform actions on your app icon in the
- * user's dock on macOS.
- *
- * @platform darwin
- */
- readonly dock: Dock;
- /**
- * A `Boolean` property that returns `true` if the app is packaged, `false`
- * otherwise. For many apps, this property can be used to distinguish development
- * and production environments.
- *
- */
- readonly isPackaged: boolean;
- /**
- * A `String` property that indicates the current application's name, which is the
- * name in the application's `package.json` file.
- *
- * Usually the `name` field of `package.json` is a short lowercase name, according
- * to the npm modules spec. You should usually also specify a `productName` field,
- * which is your application's full capitalized name, and which will be preferred
- * over `name` by Electron.
- */
- name: string;
- /**
- * A `String` which is the user agent string Electron will use as a global
- * fallback.
- *
- * This is the user agent that will be used when no user agent is set at the
- * `webContents` or `session` level. It is useful for ensuring that your entire
- * app has the same user agent. Set to a custom value as early as possible in your
- * app's initialization to ensure that your overridden value is used.
- */
- userAgentFallback: string;
- }
-
- interface AutoUpdater extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/auto-updater
-
- /**
- * This event is emitted after a user calls `quitAndInstall()`.
- *
- * When this API is called, the `before-quit` event is not emitted before all
- * windows are closed. As a result you should listen to this event if you wish to
- * perform actions before the windows are closed while a process is quitting, as
- * well as listening to `before-quit`.
- */
- on(event: 'before-quit-for-update', listener: Function): this;
- once(event: 'before-quit-for-update', listener: Function): this;
- addListener(event: 'before-quit-for-update', listener: Function): this;
- removeListener(event: 'before-quit-for-update', listener: Function): this;
- /**
- * Emitted when checking if an update has started.
- */
- on(event: 'checking-for-update', listener: Function): this;
- once(event: 'checking-for-update', listener: Function): this;
- addListener(event: 'checking-for-update', listener: Function): this;
- removeListener(event: 'checking-for-update', listener: Function): this;
- /**
- * Emitted when there is an error while updating.
- */
- on(event: 'error', listener: (error: Error) => void): this;
- once(event: 'error', listener: (error: Error) => void): this;
- addListener(event: 'error', listener: (error: Error) => void): this;
- removeListener(event: 'error', listener: (error: Error) => void): this;
- /**
- * Emitted when there is an available update. The update is downloaded
- * automatically.
- */
- on(event: 'update-available', listener: Function): this;
- once(event: 'update-available', listener: Function): this;
- addListener(event: 'update-available', listener: Function): this;
- removeListener(event: 'update-available', listener: Function): this;
- /**
- * Emitted when an update has been downloaded.
- *
- * On Windows only `releaseName` is available.
- *
- * **Note:** It is not strictly necessary to handle this event. A successfully
- * downloaded update will still be applied the next time the application starts.
- */
- on(event: 'update-downloaded', listener: (event: Event,
- releaseNotes: string,
- releaseName: string,
- releaseDate: Date,
- updateURL: string) => void): this;
- once(event: 'update-downloaded', listener: (event: Event,
- releaseNotes: string,
- releaseName: string,
- releaseDate: Date,
- updateURL: string) => void): this;
- addListener(event: 'update-downloaded', listener: (event: Event,
- releaseNotes: string,
- releaseName: string,
- releaseDate: Date,
- updateURL: string) => void): this;
- removeListener(event: 'update-downloaded', listener: (event: Event,
- releaseNotes: string,
- releaseName: string,
- releaseDate: Date,
- updateURL: string) => void): this;
- /**
- * Emitted when there is no available update.
- */
- on(event: 'update-not-available', listener: Function): this;
- once(event: 'update-not-available', listener: Function): this;
- addListener(event: 'update-not-available', listener: Function): this;
- removeListener(event: 'update-not-available', listener: Function): this;
- /**
- * Asks the server whether there is an update. You must call `setFeedURL` before
- * using this API.
- */
- checkForUpdates(): void;
- /**
- * The current update feed URL.
- */
- getFeedURL(): string;
- /**
- * Restarts the app and installs the update after it has been downloaded. It should
- * only be called after `update-downloaded` has been emitted.
- *
- * Under the hood calling `autoUpdater.quitAndInstall()` will close all application
- * windows first, and automatically call `app.quit()` after all windows have been
- * closed.
- *
- * **Note:** It is not strictly necessary to call this function to apply an update,
- * as a successfully downloaded update will always be applied the next time the
- * application starts.
- */
- quitAndInstall(): void;
- /**
- * Sets the `url` and initialize the auto updater.
- */
- setFeedURL(options: FeedURLOptions): void;
- }
-
- interface BluetoothDevice {
-
- // Docs: http://electronjs.org/docs/api/structures/bluetooth-device
-
- deviceId: string;
- deviceName: string;
- }
-
- class BrowserView {
-
- // Docs: http://electronjs.org/docs/api/browser-view
-
- /**
- * BrowserView
- */
- constructor(options?: BrowserViewConstructorOptions);
- /**
- * The view with the given `id`.
- */
- static fromId(id: number): BrowserView;
- /**
- * The BrowserView that owns the given `webContents` or `null` if the contents are
- * not owned by a BrowserView.
- */
- static fromWebContents(webContents: WebContents): (BrowserView) | (null);
- /**
- * An array of all opened BrowserViews.
- */
- static getAllViews(): BrowserView[];
- /**
- * Force closing the view, the `unload` and `beforeunload` events won't be emitted
- * for the web page. After you're done with a view, call this function in order to
- * free memory and other resources as soon as possible.
- */
- destroy(): void;
- /**
- * The `bounds` of this BrowserView instance as `Object`.
- *
- * @experimental
- */
- getBounds(): Rectangle;
- /**
- * Whether the view is destroyed.
- */
- isDestroyed(): boolean;
- setAutoResize(options: AutoResizeOptions): void;
- setBackgroundColor(color: string): void;
- /**
- * Resizes and moves the view to the supplied bounds relative to the window.
- *
- * @experimental
- */
- setBounds(bounds: Rectangle): void;
- id: number;
- webContents: WebContents;
- }
-
- class BrowserWindow extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/browser-window
-
- /**
- * Emitted when the window is set or unset to show always on top of other windows.
- */
- on(event: 'always-on-top-changed', listener: (event: Event,
- isAlwaysOnTop: boolean) => void): this;
- once(event: 'always-on-top-changed', listener: (event: Event,
- isAlwaysOnTop: boolean) => void): this;
- addListener(event: 'always-on-top-changed', listener: (event: Event,
- isAlwaysOnTop: boolean) => void): this;
- removeListener(event: 'always-on-top-changed', listener: (event: Event,
- isAlwaysOnTop: boolean) => void): this;
- /**
- * Emitted when an App Command is invoked. These are typically related to keyboard
- * media keys or browser commands, as well as the "Back" button built into some
- * mice on Windows.
- *
- * Commands are lowercased, underscores are replaced with hyphens, and the
- * `APPCOMMAND_` prefix is stripped off. e.g. `APPCOMMAND_BROWSER_BACKWARD` is
- * emitted as `browser-backward`.
- *
- * The following app commands are explicitly supported on Linux:
- *
-* `browser-backward`
-* `browser-forward`
- *
- * @platform win32,linux
- */
- on(event: 'app-command', listener: (event: Event,
- command: string) => void): this;
- once(event: 'app-command', listener: (event: Event,
- command: string) => void): this;
- addListener(event: 'app-command', listener: (event: Event,
- command: string) => void): this;
- removeListener(event: 'app-command', listener: (event: Event,
- command: string) => void): this;
- /**
- * Emitted when the window loses focus.
- */
- on(event: 'blur', listener: Function): this;
- once(event: 'blur', listener: Function): this;
- addListener(event: 'blur', listener: Function): this;
- removeListener(event: 'blur', listener: Function): this;
- /**
- * Emitted when the window is going to be closed. It's emitted before the
- * `beforeunload` and `unload` event of the DOM. Calling `event.preventDefault()`
- * will cancel the close.
- *
- * Usually you would want to use the `beforeunload` handler to decide whether the
- * window should be closed, which will also be called when the window is reloaded.
- * In Electron, returning any value other than `undefined` would cancel the close.
- * For example:
- *
- * _**Note**: There is a subtle difference between the behaviors of
- * `window.onbeforeunload = handler` and `window.addEventListener('beforeunload',
- * handler)`. It is recommended to always set the `event.returnValue` explicitly,
- * instead of only returning a value, as the former works more consistently within
- * Electron._
- */
- on(event: 'close', listener: (event: Event) => void): this;
- once(event: 'close', listener: (event: Event) => void): this;
- addListener(event: 'close', listener: (event: Event) => void): this;
- removeListener(event: 'close', listener: (event: Event) => void): this;
- /**
- * Emitted when the window is closed. After you have received this event you should
- * remove the reference to the window and avoid using it any more.
- */
- on(event: 'closed', listener: Function): this;
- once(event: 'closed', listener: Function): this;
- addListener(event: 'closed', listener: Function): this;
- removeListener(event: 'closed', listener: Function): this;
- /**
- * Emitted when the window enters a full-screen state.
- */
- on(event: 'enter-full-screen', listener: Function): this;
- once(event: 'enter-full-screen', listener: Function): this;
- addListener(event: 'enter-full-screen', listener: Function): this;
- removeListener(event: 'enter-full-screen', listener: Function): this;
- /**
- * Emitted when the window enters a full-screen state triggered by HTML API.
- */
- on(event: 'enter-html-full-screen', listener: Function): this;
- once(event: 'enter-html-full-screen', listener: Function): this;
- addListener(event: 'enter-html-full-screen', listener: Function): this;
- removeListener(event: 'enter-html-full-screen', listener: Function): this;
- /**
- * Emitted when the window gains focus.
- */
- on(event: 'focus', listener: Function): this;
- once(event: 'focus', listener: Function): this;
- addListener(event: 'focus', listener: Function): this;
- removeListener(event: 'focus', listener: Function): this;
- /**
- * Emitted when the window is hidden.
- */
- on(event: 'hide', listener: Function): this;
- once(event: 'hide', listener: Function): this;
- addListener(event: 'hide', listener: Function): this;
- removeListener(event: 'hide', listener: Function): this;
- /**
- * Emitted when the window leaves a full-screen state.
- */
- on(event: 'leave-full-screen', listener: Function): this;
- once(event: 'leave-full-screen', listener: Function): this;
- addListener(event: 'leave-full-screen', listener: Function): this;
- removeListener(event: 'leave-full-screen', listener: Function): this;
- /**
- * Emitted when the window leaves a full-screen state triggered by HTML API.
- */
- on(event: 'leave-html-full-screen', listener: Function): this;
- once(event: 'leave-html-full-screen', listener: Function): this;
- addListener(event: 'leave-html-full-screen', listener: Function): this;
- removeListener(event: 'leave-html-full-screen', listener: Function): this;
- /**
- * Emitted when window is maximized.
- */
- on(event: 'maximize', listener: Function): this;
- once(event: 'maximize', listener: Function): this;
- addListener(event: 'maximize', listener: Function): this;
- removeListener(event: 'maximize', listener: Function): this;
- /**
- * Emitted when the window is minimized.
- */
- on(event: 'minimize', listener: Function): this;
- once(event: 'minimize', listener: Function): this;
- addListener(event: 'minimize', listener: Function): this;
- removeListener(event: 'minimize', listener: Function): this;
- /**
- * Emitted when the window is being moved to a new position.
- *
-__Note__: On macOS this event is an alias of `moved`.
- */
- on(event: 'move', listener: Function): this;
- once(event: 'move', listener: Function): this;
- addListener(event: 'move', listener: Function): this;
- removeListener(event: 'move', listener: Function): this;
- /**
- * Emitted once when the window is moved to a new position.
- *
- * @platform darwin
- */
- on(event: 'moved', listener: Function): this;
- once(event: 'moved', listener: Function): this;
- addListener(event: 'moved', listener: Function): this;
- removeListener(event: 'moved', listener: Function): this;
- /**
- * Emitted when the native new tab button is clicked.
- *
- * @platform darwin
- */
- on(event: 'new-window-for-tab', listener: Function): this;
- once(event: 'new-window-for-tab', listener: Function): this;
- addListener(event: 'new-window-for-tab', listener: Function): this;
- removeListener(event: 'new-window-for-tab', listener: Function): this;
- /**
- * Emitted when the document changed its title, calling `event.preventDefault()`
- * will prevent the native window's title from changing. `explicitSet` is false
- * when title is synthesized from file URL.
- */
- on(event: 'page-title-updated', listener: (event: Event,
- title: string,
- explicitSet: boolean) => void): this;
- once(event: 'page-title-updated', listener: (event: Event,
- title: string,
- explicitSet: boolean) => void): this;
- addListener(event: 'page-title-updated', listener: (event: Event,
- title: string,
- explicitSet: boolean) => void): this;
- removeListener(event: 'page-title-updated', listener: (event: Event,
- title: string,
- explicitSet: boolean) => void): this;
- /**
- * Emitted when the web page has been rendered (while not being shown) and window
- * can be displayed without a visual flash.
- *
- * Please note that using this event implies that the renderer will be considered
- * "visible" and paint even though `show` is false. This event will never fire if
- * you use `paintWhenInitiallyHidden: false`
- */
- on(event: 'ready-to-show', listener: Function): this;
- once(event: 'ready-to-show', listener: Function): this;
- addListener(event: 'ready-to-show', listener: Function): this;
- removeListener(event: 'ready-to-show', listener: Function): this;
- /**
- * Emitted after the window has been resized.
- */
- on(event: 'resize', listener: Function): this;
- once(event: 'resize', listener: Function): this;
- addListener(event: 'resize', listener: Function): this;
- removeListener(event: 'resize', listener: Function): this;
- /**
- * Emitted when the unresponsive web page becomes responsive again.
- */
- on(event: 'responsive', listener: Function): this;
- once(event: 'responsive', listener: Function): this;
- addListener(event: 'responsive', listener: Function): this;
- removeListener(event: 'responsive', listener: Function): this;
- /**
- * Emitted when the window is restored from a minimized state.
- */
- on(event: 'restore', listener: Function): this;
- once(event: 'restore', listener: Function): this;
- addListener(event: 'restore', listener: Function): this;
- removeListener(event: 'restore', listener: Function): this;
- /**
- * Emitted on trackpad rotation gesture. Continually emitted until rotation gesture
- * is ended. The `rotation` value on each emission is the angle in degrees rotated
- * since the last emission. The last emitted event upon a rotation gesture will
- * always be of value `0`. Counter-clockwise rotation values are positive, while
- * clockwise ones are negative.
- *
- * @platform darwin
- */
- on(event: 'rotate-gesture', listener: (event: Event,
- rotation: number) => void): this;
- once(event: 'rotate-gesture', listener: (event: Event,
- rotation: number) => void): this;
- addListener(event: 'rotate-gesture', listener: (event: Event,
- rotation: number) => void): this;
- removeListener(event: 'rotate-gesture', listener: (event: Event,
- rotation: number) => void): this;
- /**
- * Emitted when scroll wheel event phase has begun.
- *
- * @platform darwin
- */
- on(event: 'scroll-touch-begin', listener: Function): this;
- once(event: 'scroll-touch-begin', listener: Function): this;
- addListener(event: 'scroll-touch-begin', listener: Function): this;
- removeListener(event: 'scroll-touch-begin', listener: Function): this;
- /**
- * Emitted when scroll wheel event phase filed upon reaching the edge of element.
- *
- * @platform darwin
- */
- on(event: 'scroll-touch-edge', listener: Function): this;
- once(event: 'scroll-touch-edge', listener: Function): this;
- addListener(event: 'scroll-touch-edge', listener: Function): this;
- removeListener(event: 'scroll-touch-edge', listener: Function): this;
- /**
- * Emitted when scroll wheel event phase has ended.
- *
- * @platform darwin
- */
- on(event: 'scroll-touch-end', listener: Function): this;
- once(event: 'scroll-touch-end', listener: Function): this;
- addListener(event: 'scroll-touch-end', listener: Function): this;
- removeListener(event: 'scroll-touch-end', listener: Function): this;
- /**
- * Emitted when window session is going to end due to force shutdown or machine
- * restart or session log off.
- *
- * @platform win32
- */
- on(event: 'session-end', listener: Function): this;
- once(event: 'session-end', listener: Function): this;
- addListener(event: 'session-end', listener: Function): this;
- removeListener(event: 'session-end', listener: Function): this;
- /**
- * Emitted when the window opens a sheet.
- *
- * @platform darwin
- */
- on(event: 'sheet-begin', listener: Function): this;
- once(event: 'sheet-begin', listener: Function): this;
- addListener(event: 'sheet-begin', listener: Function): this;
- removeListener(event: 'sheet-begin', listener: Function): this;
- /**
- * Emitted when the window has closed a sheet.
- *
- * @platform darwin
- */
- on(event: 'sheet-end', listener: Function): this;
- once(event: 'sheet-end', listener: Function): this;
- addListener(event: 'sheet-end', listener: Function): this;
- removeListener(event: 'sheet-end', listener: Function): this;
- /**
- * Emitted when the window is shown.
- */
- on(event: 'show', listener: Function): this;
- once(event: 'show', listener: Function): this;
- addListener(event: 'show', listener: Function): this;
- removeListener(event: 'show', listener: Function): this;
- /**
- * Emitted on 3-finger swipe. Possible directions are `up`, `right`, `down`,
- * `left`.
- *
- * @platform darwin
- */
- on(event: 'swipe', listener: (event: Event,
- direction: string) => void): this;
- once(event: 'swipe', listener: (event: Event,
- direction: string) => void): this;
- addListener(event: 'swipe', listener: (event: Event,
- direction: string) => void): this;
- removeListener(event: 'swipe', listener: (event: Event,
- direction: string) => void): this;
- /**
- * Emitted when the window exits from a maximized state.
- */
- on(event: 'unmaximize', listener: Function): this;
- once(event: 'unmaximize', listener: Function): this;
- addListener(event: 'unmaximize', listener: Function): this;
- removeListener(event: 'unmaximize', listener: Function): this;
- /**
- * Emitted when the web page becomes unresponsive.
- */
- on(event: 'unresponsive', listener: Function): this;
- once(event: 'unresponsive', listener: Function): this;
- addListener(event: 'unresponsive', listener: Function): this;
- removeListener(event: 'unresponsive', listener: Function): this;
- /**
- * Emitted before the window is moved. Calling `event.preventDefault()` will
- * prevent the window from being moved.
- *
- * Note that this is only emitted when the window is being resized manually.
- * Resizing the window with `setBounds`/`setSize` will not emit this event.
- *
- * @platform win32
- */
- on(event: 'will-move', listener: (event: Event,
- /**
- * Location the window is being moved to.
- */
- newBounds: `Rectangle`) => void): this;
- once(event: 'will-move', listener: (event: Event,
- /**
- * Location the window is being moved to.
- */
- newBounds: `Rectangle`) => void): this;
- addListener(event: 'will-move', listener: (event: Event,
- /**
- * Location the window is being moved to.
- */
- newBounds: `Rectangle`) => void): this;
- removeListener(event: 'will-move', listener: (event: Event,
- /**
- * Location the window is being moved to.
- */
- newBounds: `Rectangle`) => void): this;
- /**
- * Emitted before the window is resized. Calling `event.preventDefault()` will
- * prevent the window from being resized.
- *
- * Note that this is only emitted when the window is being resized manually.
- * Resizing the window with `setBounds`/`setSize` will not emit this event.
- *
- * @platform darwin,win32
- */
- on(event: 'will-resize', listener: (event: Event,
- /**
- * Size the window is being resized to.
- */
- newBounds: `Rectangle`) => void): this;
- once(event: 'will-resize', listener: (event: Event,
- /**
- * Size the window is being resized to.
- */
- newBounds: `Rectangle`) => void): this;
- addListener(event: 'will-resize', listener: (event: Event,
- /**
- * Size the window is being resized to.
- */
- newBounds: `Rectangle`) => void): this;
- removeListener(event: 'will-resize', listener: (event: Event,
- /**
- * Size the window is being resized to.
- */
- newBounds: `Rectangle`) => void): this;
- /**
- * BrowserWindow
- */
- constructor(options?: BrowserWindowConstructorOptions);
- /**
- * Adds DevTools extension located at `path`, and returns extension's name.
- *
- * The extension will be remembered so you only need to call this API once, this
- * API is not for programming use. If you try to add an extension that has already
- * been loaded, this method will not return and instead log a warning to the
- * console.
- *
- * The method will also not return if the extension's manifest is missing or
- * incomplete.
- *
- * **Note:** This API cannot be called before the `ready` event of the `app` module
- * is emitted.
- */
- static addDevToolsExtension(path: string): void;
- /**
- * Adds Chrome extension located at `path`, and returns extension's name.
- *
- * The method will also not return if the extension's manifest is missing or
- * incomplete.
- *
- * **Note:** This API cannot be called before the `ready` event of the `app` module
- * is emitted.
- */
- static addExtension(path: string): void;
- /**
- * The window that owns the given `browserView`. If the given view is not attached
- * to any window, returns `null`.
- */
- static fromBrowserView(browserView: BrowserView): (BrowserWindow) | (null);
- /**
- * The window with the given `id`.
- */
- static fromId(id: number): BrowserWindow;
- /**
- * The window that owns the given `webContents`.
- */
- static fromWebContents(webContents: WebContents): BrowserWindow;
- /**
- * An array of all opened browser windows.
- */
- static getAllWindows(): BrowserWindow[];
- /**
- * The keys are the extension names and each value is an Object containing `name`
- * and `version` properties.
- *
- * To check if a DevTools extension is installed you can run the following:
- *
- * **Note:** This API cannot be called before the `ready` event of the `app` module
- * is emitted.
- */
- static getDevToolsExtensions(): Record;
- /**
- * The keys are the extension names and each value is an Object containing `name`
- * and `version` properties.
- *
- * **Note:** This API cannot be called before the `ready` event of the `app` module
- * is emitted.
- */
- static getExtensions(): Record;
- /**
- * The window that is focused in this application, otherwise returns `null`.
- */
- static getFocusedWindow(): (BrowserWindow) | (null);
- /**
- * Remove a DevTools extension by name.
- *
- * **Note:** This API cannot be called before the `ready` event of the `app` module
- * is emitted.
- */
- static removeDevToolsExtension(name: string): void;
- /**
- * Remove a Chrome extension by name.
- *
- * **Note:** This API cannot be called before the `ready` event of the `app` module
- * is emitted.
- */
- static removeExtension(name: string): void;
- /**
- * Replacement API for setBrowserView supporting work with multi browser views.
- *
- * @experimental
- */
- addBrowserView(browserView: BrowserView): void;
- /**
- * Adds a window as a tab on this window, after the tab for the window instance.
- *
- * @platform darwin
- */
- addTabbedWindow(browserWindow: BrowserWindow): void;
- /**
- * Removes focus from the window.
- */
- blur(): void;
- blurWebView(): void;
- /**
- * Resolves with a NativeImage
- *
- * Captures a snapshot of the page within `rect`. Omitting `rect` will capture the
- * whole visible page.
- */
- capturePage(rect?: Rectangle): Promise;
- /**
- * Moves window to the center of the screen.
- */
- center(): void;
- /**
- * Try to close the window. This has the same effect as a user manually clicking
- * the close button of the window. The web page may cancel the close though. See
- * the close event.
- */
- close(): void;
- /**
- * Closes the currently open Quick Look panel.
- *
- * @platform darwin
- */
- closeFilePreview(): void;
- /**
- * Force closing the window, the `unload` and `beforeunload` event won't be emitted
- * for the web page, and `close` event will also not be emitted for this window,
- * but it guarantees the `closed` event will be emitted.
- */
- destroy(): void;
- /**
- * Starts or stops flashing the window to attract user's attention.
- */
- flashFrame(flag: boolean): void;
- /**
- * Focuses on the window.
- */
- focus(): void;
- focusOnWebView(): void;
- /**
- * The `bounds` of the window as `Object`.
- */
- getBounds(): Rectangle;
- /**
- * an BrowserView what is attached. Returns `null` if none is attached. Throw error
- * if multiple BrowserViews is attached.
- *
- * @experimental
- */
- getBrowserView(): (BrowserView) | (null);
- /**
- * an array of all BrowserViews that have been attached with `addBrowserView` or
- * `setBrowserView`.
- *
- * **Note:** The BrowserView API is currently experimental and may change or be
- * removed in future Electron releases.
- *
- * @experimental
- */
- getBrowserViews(): BrowserView[];
- /**
- * All child windows.
- */
- getChildWindows(): BrowserWindow[];
- /**
- * The `bounds` of the window's client area as `Object`.
- */
- getContentBounds(): Rectangle;
- /**
- * Contains the window's client area's width and height.
- */
- getContentSize(): number[];
- /**
- * Contains the window's maximum width and height.
- */
- getMaximumSize(): number[];
- /**
- * Contains the window's minimum width and height.
- */
- getMinimumSize(): number[];
- /**
- * The platform-specific handle of the window.
- *
- * The native type of the handle is `HWND` on Windows, `NSView*` on macOS, and
- * `Window` (`unsigned long`) on Linux.
- */
- getNativeWindowHandle(): Buffer;
- /**
- * Contains the window bounds of the normal state
- *
- * **Note:** whatever the current state of the window : maximized, minimized or in
- * fullscreen, this function always returns the position and size of the window in
- * normal state. In normal state, getBounds and getNormalBounds returns the same
- * `Rectangle`.
- */
- getNormalBounds(): Rectangle;
- /**
- * between 0.0 (fully transparent) and 1.0 (fully opaque). On Linux, always returns
- * 1.
- */
- getOpacity(): number;
- /**
- * The parent window.
- */
- getParentWindow(): BrowserWindow;
- /**
- * Contains the window's current position.
- */
- getPosition(): number[];
- /**
- * The pathname of the file the window represents.
- *
- * @platform darwin
- */
- getRepresentedFilename(): string;
- /**
- * Contains the window's width and height.
- */
- getSize(): number[];
- /**
- * The title of the native window.
- *
- * **Note:** The title of the web page can be different from the title of the
- * native window.
- */
- getTitle(): string;
- /**
- * Whether the window has a shadow.
- */
- hasShadow(): boolean;
- /**
- * Hides the window.
- */
- hide(): void;
- /**
- * Hooks a windows message. The `callback` is called when the message is received
- * in the WndProc.
- *
- * @platform win32
- */
- hookWindowMessage(message: number, callback: () => void): void;
- /**
- * Whether the window is always on top of other windows.
- */
- isAlwaysOnTop(): boolean;
- /**
- * Whether the window can be manually closed by user.
- *
-On Linux always returns `true`.
-
-**Deprecated**
- *
- * @platform darwin,win32
- */
- isClosable(): boolean;
- /**
- * Whether the window is destroyed.
- */
- isDestroyed(): boolean;
- /**
- * Whether the window's document has been edited.
- *
- * @platform darwin
- */
- isDocumentEdited(): boolean;
- /**
- * Returns Boolean - whether the window is enabled.
- */
- isEnabled(): void;
- /**
- * Whether the window is focused.
- */
- isFocused(): boolean;
- /**
- * Whether the window is in fullscreen mode.
- */
- isFullScreen(): boolean;
- /**
- * Whether the maximize/zoom window button toggles fullscreen mode or maximizes the
- * window.
-
-**Deprecated**
- */
- isFullScreenable(): boolean;
- /**
- * Whether the window is in kiosk mode.
- */
- isKiosk(): boolean;
- /**
- * Whether the window can be manually maximized by user.
- *
-On Linux always returns `true`.
-
-**Deprecated**
- *
- * @platform darwin,win32
- */
- isMaximizable(): boolean;
- /**
- * Whether the window is maximized.
- */
- isMaximized(): boolean;
- /**
- * Whether menu bar automatically hides itself.
-
-**Deprecated**
- */
- isMenuBarAutoHide(): boolean;
- /**
- * Whether the menu bar is visible.
- */
- isMenuBarVisible(): boolean;
- /**
- * Whether the window can be manually minimized by user
- *
-On Linux always returns `true`.
-
-**Deprecated**
- *
- * @platform darwin,win32
- */
- isMinimizable(): boolean;
- /**
- * Whether the window is minimized.
- */
- isMinimized(): boolean;
- /**
- * Whether current window is a modal window.
- */
- isModal(): boolean;
- /**
- * Whether the window can be moved by user.
- *
-On Linux always returns `true`.
-
-**Deprecated**
- *
- * @platform darwin,win32
- */
- isMovable(): boolean;
- /**
- * Whether the window is in normal state (not maximized, not minimized, not in
- * fullscreen mode).
- */
- isNormal(): boolean;
- /**
- * Whether the window can be manually resized by user.
-
-**Deprecated**
- */
- isResizable(): boolean;
- /**
- * Whether the window is in simple (pre-Lion) fullscreen mode.
- *
- * @platform darwin
- */
- isSimpleFullScreen(): boolean;
- /**
- * Whether the window is visible to the user.
- */
- isVisible(): boolean;
- /**
- * Whether the window is visible on all workspaces.
- *
-**Note:** This API always returns false on Windows.
- */
- isVisibleOnAllWorkspaces(): boolean;
- /**
- * `true` or `false` depending on whether the message is hooked.
- *
- * @platform win32
- */
- isWindowMessageHooked(message: number): boolean;
- /**
- * the promise will resolve when the page has finished loading (see
- * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
- *
- * Same as `webContents.loadFile`, `filePath` should be a path to an HTML file
- * relative to the root of your application. See the `webContents` docs for more
- * information.
- */
- loadFile(filePath: string, options?: LoadFileOptions): Promise;
- /**
- * the promise will resolve when the page has finished loading (see
- * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
- *
- * Same as `webContents.loadURL(url[, options])`.
- *
- * The `url` can be a remote address (e.g. `http://`) or a path to a local HTML
- * file using the `file://` protocol.
- *
- * To ensure that file URLs are properly formatted, it is recommended to use Node's
- * `url.format` method:
- *
- * You can load a URL using a `POST` request with URL-encoded data by doing the
- * following:
- */
- loadURL(url: string, options?: LoadURLOptions): Promise;
- /**
- * Maximizes the window. This will also show (but not focus) the window if it isn't
- * being displayed already.
- */
- maximize(): void;
- /**
- * Merges all windows into one window with multiple tabs when native tabs are
- * enabled and there is more than one open window.
- *
- * @platform darwin
- */
- mergeAllWindows(): void;
- /**
- * Minimizes the window. On some platforms the minimized window will be shown in
- * the Dock.
- */
- minimize(): void;
- /**
- * Moves the current tab into a new window if native tabs are enabled and there is
- * more than one tab in the current window.
- *
- * @platform darwin
- */
- moveTabToNewWindow(): void;
- /**
- * Moves window to top(z-order) regardless of focus
- */
- moveTop(): void;
- /**
- * Uses Quick Look to preview a file at a given path.
- *
- * @platform darwin
- */
- previewFile(path: string, displayName?: string): void;
- /**
- * Same as `webContents.reload`.
- */
- reload(): void;
- removeBrowserView(browserView: BrowserView): void;
- /**
- * Remove the window's menu bar.
- *
- * @platform linux,win32
- */
- removeMenu(): void;
- /**
- * Restores the window from minimized state to its previous state.
- */
- restore(): void;
- /**
- * Selects the next tab when native tabs are enabled and there are other tabs in
- * the window.
- *
- * @platform darwin
- */
- selectNextTab(): void;
- /**
- * Selects the previous tab when native tabs are enabled and there are other tabs
- * in the window.
- *
- * @platform darwin
- */
- selectPreviousTab(): void;
- /**
- * Sets whether the window should show always on top of other windows. After
- * setting this, the window is still a normal window, not a toolbox window which
- * can not be focused on.
- */
- setAlwaysOnTop(flag: boolean, level?: 'normal' | 'floating' | 'torn-off-menu' | 'modal-panel' | 'main-menu' | 'status' | 'pop-up-menu' | 'screen-saver', relativeLevel?: number): void;
- /**
- * Sets the properties for the window's taskbar button.
- *
- * **Note:** `relaunchCommand` and `relaunchDisplayName` must always be set
- * together. If one of those properties is not set, then neither will be used.
- *
- * @platform win32
- */
- setAppDetails(options: AppDetailsOptions): void;
- /**
- * This will make a window maintain an aspect ratio. The extra size allows a
- * developer to have space, specified in pixels, not included within the aspect
- * ratio calculations. This API already takes into account the difference between a
- * window's size and its content size.
- *
- * Consider a normal window with an HD video player and associated controls.
- * Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls
- * on the right edge and 50 pixels of controls below the player. In order to
- * maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within
- * the player itself we would call this function with arguments of 16/9 and [ 40,
- * 50 ]. The second argument doesn't care where the extra width and height are
- * within the content view--only that they exist. Sum any extra width and height
- * areas you have within the overall content view.
- *
- * Calling this function with a value of `0` will remove any previously set aspect
- * ratios.
- *
- * @platform darwin
- */
- setAspectRatio(aspectRatio: number, extraSize?: Size): void;
- /**
- * Controls whether to hide cursor when typing.
- *
- * @platform darwin
- */
- setAutoHideCursor(autoHide: boolean): void;
- /**
- * Sets whether the window menu bar should hide itself automatically. Once set the
- * menu bar will only show when users press the single `Alt` key.
- *
- * If the menu bar is already visible, calling `setAutoHideMenuBar(true)` won't
- * hide it immediately.
-
-**Deprecated**
- */
- setAutoHideMenuBar(hide: boolean): void;
- /**
- * Sets the background color of the window. See Setting `backgroundColor`.
- */
- setBackgroundColor(backgroundColor: string): void;
- /**
- * Resizes and moves the window to the supplied bounds. Any properties that are not
- * supplied will default to their current values.
- */
- setBounds(bounds: Partial, animate?: boolean): void;
- setBrowserView(browserView: (BrowserView) | (null)): void;
- /**
- * Sets whether the window can be manually closed by user. On Linux does nothing.
- *
-**Deprecated**
- *
- * @platform darwin,win32
- */
- setClosable(closable: boolean): void;
- /**
- * Resizes and moves the window's client area (e.g. the web page) to the supplied
- * bounds.
- */
- setContentBounds(bounds: Rectangle, animate?: boolean): void;
- /**
- * Prevents the window contents from being captured by other apps.
- *
- * On macOS it sets the NSWindow's sharingType to NSWindowSharingNone. On Windows
- * it calls SetWindowDisplayAffinity with `WDA_MONITOR`.
- *
- * @platform darwin,win32
- */
- setContentProtection(enable: boolean): void;
- /**
- * Resizes the window's client area (e.g. the web page) to `width` and `height`.
- */
- setContentSize(width: number, height: number, animate?: boolean): void;
- /**
- * Specifies whether the window’s document has been edited, and the icon in title
- * bar will become gray when set to `true`.
- *
- * @platform darwin
- */
- setDocumentEdited(edited: boolean): void;
- /**
- * Disable or enable the window.
- */
- setEnabled(enable: boolean): void;
- /**
- * Changes whether the window can be focused.
- *
-On macOS it does not remove the focus from the window.
- *
- * @platform darwin,win32
- */
- setFocusable(focusable: boolean): void;
- /**
- * Sets whether the window should be in fullscreen mode.
- */
- setFullScreen(flag: boolean): void;
- /**
- * Sets whether the maximize/zoom window button toggles fullscreen mode or
- * maximizes the window.
-
-**Deprecated**
- */
- setFullScreenable(fullscreenable: boolean): void;
- /**
- * Sets whether the window should have a shadow.
- */
- setHasShadow(hasShadow: boolean): void;
- /**
- * Changes window icon.
- *
- * @platform win32,linux
- */
- setIcon(icon: NativeImage): void;
- /**
- * Makes the window ignore all mouse events.
- *
- * All mouse events happened in this window will be passed to the window below this
- * window, but if this window has focus, it will still receive keyboard events.
- */
- setIgnoreMouseEvents(ignore: boolean, options?: IgnoreMouseEventsOptions): void;
- /**
- * Enters or leaves the kiosk mode.
- */
- setKiosk(flag: boolean): void;
- /**
- * Sets whether the window can be manually maximized by user. On Linux does
- * nothing.
-
-**Deprecated**
- *
- * @platform darwin,win32
- */
- setMaximizable(maximizable: boolean): void;
- /**
- * Sets the maximum size of window to `width` and `height`.
- */
- setMaximumSize(width: number, height: number): void;
- /**
- * Sets the `menu` as the window's menu bar.
- *
- * @platform linux,win32
- */
- setMenu(menu: (Menu) | (null)): void;
- /**
- * Sets whether the menu bar should be visible. If the menu bar is auto-hide, users
- * can still bring up the menu bar by pressing the single `Alt` key.
- *
- * @platform win32,linux
- */
- setMenuBarVisibility(visible: boolean): void;
- /**
- * Sets whether the window can be manually minimized by user. On Linux does
- * nothing.
-
-**Deprecated**
- *
- * @platform darwin,win32
- */
- setMinimizable(minimizable: boolean): void;
- /**
- * Sets the minimum size of window to `width` and `height`.
- */
- setMinimumSize(width: number, height: number): void;
- /**
- * Sets whether the window can be moved by user. On Linux does nothing.
- *
-**Deprecated**
- *
- * @platform darwin,win32
- */
- setMovable(movable: boolean): void;
- /**
- * Sets the opacity of the window. On Linux, does nothing. Out of bound number
- * values are clamped to the [0, 1] range.
- *
- * @platform win32,darwin
- */
- setOpacity(opacity: number): void;
- /**
- * Sets a 16 x 16 pixel overlay onto the current taskbar icon, usually used to
- * convey some sort of application status or to passively notify the user.
- *
- * @platform win32
- */
- setOverlayIcon(overlay: (NativeImage) | (null), description: string): void;
- /**
- * Sets `parent` as current window's parent window, passing `null` will turn
- * current window into a top-level window.
- */
- setParentWindow(parent: (BrowserWindow) | (null)): void;
- /**
- * Moves window to `x` and `y`.
- */
- setPosition(x: number, y: number, animate?: boolean): void;
- /**
- * Sets progress value in progress bar. Valid range is [0, 1.0].
- *
- * Remove progress bar when progress < 0; Change to indeterminate mode when
- * progress > 1.
- *
- * On Linux platform, only supports Unity desktop environment, you need to specify
- * the `*.desktop` file name to `desktopName` field in `package.json`. By default,
- * it will assume `{app.name}.desktop`.
- *
- * On Windows, a mode can be passed. Accepted values are `none`, `normal`,
- * `indeterminate`, `error`, and `paused`. If you call `setProgressBar` without a
- * mode set (but with a value within the valid range), `normal` will be assumed.
- */
- setProgressBar(progress: number, options?: ProgressBarOptions): void;
- /**
- * Sets the pathname of the file the window represents, and the icon of the file
- * will show in window's title bar.
- *
- * @platform darwin
- */
- setRepresentedFilename(filename: string): void;
- /**
- * Sets whether the window can be manually resized by user.
-
-**Deprecated**
- */
- setResizable(resizable: boolean): void;
- /**
- * Setting a window shape determines the area within the window where the system
- * permits drawing and user interaction. Outside of the given region, no pixels
- * will be drawn and no mouse events will be registered. Mouse events outside of
- * the region will not be received by that window, but will fall through to
- * whatever is behind the window.
- *
- * @experimental
- * @platform win32,linux
- */
- setShape(rects: Rectangle[]): void;
- /**
- * Changes the attachment point for sheets on macOS. By default, sheets are
- * attached just below the window frame, but you may want to display them beneath a
- * HTML-rendered toolbar. For example:
- *
- * @platform darwin
- */
- setSheetOffset(offsetY: number, offsetX?: number): void;
- /**
- * Enters or leaves simple fullscreen mode.
- *
- * Simple fullscreen mode emulates the native fullscreen behavior found in versions
- * of Mac OS X prior to Lion (10.7).
- *
- * @platform darwin
- */
- setSimpleFullScreen(flag: boolean): void;
- /**
- * Resizes the window to `width` and `height`. If `width` or `height` are below any
- * set minimum size constraints the window will snap to its minimum size.
- */
- setSize(width: number, height: number, animate?: boolean): void;
- /**
- * Makes the window not show in the taskbar.
- */
- setSkipTaskbar(skip: boolean): void;
- /**
- * Whether the buttons were added successfully
- *
- * Add a thumbnail toolbar with a specified set of buttons to the thumbnail image
- * of a window in a taskbar button layout. Returns a `Boolean` object indicates
- * whether the thumbnail has been added successfully.
- *
- * The number of buttons in thumbnail toolbar should be no greater than 7 due to
- * the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be
- * removed due to the platform's limitation. But you can call the API with an empty
- * array to clean the buttons.
- *
- * The `buttons` is an array of `Button` objects:
- *
- * * `Button` Object
- * * `icon` NativeImage - The icon showing in thumbnail toolbar.
- * * `click` Function
- * * `tooltip` String (optional) - The text of the button's tooltip.
- * * `flags` String[] (optional) - Control specific states and behaviors of the
- * button. By default, it is `['enabled']`.
- *
- * The `flags` is an array that can include following `String`s:
- *
- * * `enabled` - The button is active and available to the user.
- * * `disabled` - The button is disabled. It is present, but has a visual state
- * indicating it will not respond to user action.
- * * `dismissonclick` - When the button is clicked, the thumbnail window closes
- * immediately.
- * * `nobackground` - Do not draw a button border, use only the image.
- * * `hidden` - The button is not shown to the user.
- * * `noninteractive` - The button is enabled but not interactive; no pressed
- * button state is drawn. This value is intended for instances where the button is
- * used in a notification.
- *
- * @platform win32
- */
- setThumbarButtons(buttons: ThumbarButton[]): boolean;
- /**
- * Sets the region of the window to show as the thumbnail image displayed when
- * hovering over the window in the taskbar. You can reset the thumbnail to be the
- * entire window by specifying an empty region: `{ x: 0, y: 0, width: 0, height: 0
- * }`.
- *
- * @platform win32
- */
- setThumbnailClip(region: Rectangle): void;
- /**
- * Sets the toolTip that is displayed when hovering over the window thumbnail in
- * the taskbar.
- *
- * @platform win32
- */
- setThumbnailToolTip(toolTip: string): void;
- /**
- * Changes the title of native window to `title`.
- */
- setTitle(title: string): void;
- /**
- * Sets the touchBar layout for the current window. Specifying `null` or
- * `undefined` clears the touch bar. This method only has an effect if the machine
- * has a touch bar and is running on macOS 10.12.1+.
- *
- * **Note:** The TouchBar API is currently experimental and may change or be
- * removed in future Electron releases.
- *
- * @experimental
- * @platform darwin
- */
- setTouchBar(touchBar: (TouchBar) | (null)): void;
- /**
- * Adds a vibrancy effect to the browser window. Passing `null` or an empty string
- * will remove the vibrancy effect on the window.
- *
- * Note that `appearance-based`, `light`, `dark`, `medium-light`, and `ultra-dark`
- * have been deprecated and will be removed in an upcoming version of macOS.
- *
- * @platform darwin
- */
- setVibrancy(type: (('appearance-based' | 'light' | 'dark' | 'titlebar' | 'selection' | 'menu' | 'popover' | 'sidebar' | 'medium-light' | 'ultra-dark' | 'header' | 'sheet' | 'window' | 'hud' | 'fullscreen-ui' | 'tooltip' | 'content' | 'under-window' | 'under-page')) | (null)): void;
- /**
- * Sets whether the window should be visible on all workspaces.
- *
-**Note:** This API does nothing on Windows.
- */
- setVisibleOnAllWorkspaces(visible: boolean, options?: VisibleOnAllWorkspacesOptions): void;
- /**
- * Sets whether the window traffic light buttons should be visible.
- *
-This cannot be called when `titleBarStyle` is set to `customButtonsOnHover`.
- *
- * @platform darwin
- */
- setWindowButtonVisibility(visible: boolean): void;
- /**
- * Shows and gives focus to the window.
- */
- show(): void;
- /**
- * Same as `webContents.showDefinitionForSelection()`.
- *
- * @platform darwin
- */
- showDefinitionForSelection(): void;
- /**
- * Shows the window but doesn't focus on it.
- */
- showInactive(): void;
- /**
- * Toggles the visibility of the tab bar if native tabs are enabled and there is
- * only one tab in the current window.
- *
- * @platform darwin
- */
- toggleTabBar(): void;
- /**
- * Unhooks all of the window messages.
- *
- * @platform win32
- */
- unhookAllWindowMessages(): void;
- /**
- * Unhook the window message.
- *
- * @platform win32
- */
- unhookWindowMessage(message: number): void;
- /**
- * Unmaximizes the window.
- */
- unmaximize(): void;
- autoHideMenuBar: boolean;
- closable: boolean;
- excludedFromShownWindowsMenu: boolean;
- fullScreenable: boolean;
- readonly id: number;
- maximizable: boolean;
- minimizable: boolean;
- movable: boolean;
- resizable: boolean;
- readonly webContents: WebContents;
- }
-
- class BrowserWindowProxy {
-
- // Docs: http://electronjs.org/docs/api/browser-window-proxy
-
- /**
- * Removes focus from the child window.
- */
- blur(): void;
- /**
- * Forcefully closes the child window without calling its unload event.
- */
- close(): void;
- /**
- * Evaluates the code in the child window.
- */
- eval(code: string): void;
- /**
- * Focuses the child window (brings the window to front).
- */
- focus(): void;
- /**
- * Sends a message to the child window with the specified origin or `*` for no
- * origin preference.
- *
- * In addition to these methods, the child window implements `window.opener` object
- * with no properties and a single method.
- */
- postMessage(message: any, targetOrigin: string): void;
- /**
- * Invokes the print dialog on the child window.
- */
- print(): void;
- closed: boolean;
- }
-
- interface Certificate {
-
- // Docs: http://electronjs.org/docs/api/structures/certificate
-
- /**
- * PEM encoded data
- */
- data: string;
- /**
- * Fingerprint of the certificate
- */
- fingerprint: string;
- /**
- * Issuer principal
- */
- issuer: CertificatePrincipal;
- /**
- * Issuer certificate (if not self-signed)
- */
- issuerCert: Certificate;
- /**
- * Issuer's Common Name
- */
- issuerName: string;
- /**
- * Hex value represented string
- */
- serialNumber: string;
- /**
- * Subject principal
- */
- subject: CertificatePrincipal;
- /**
- * Subject's Common Name
- */
- subjectName: string;
- /**
- * End date of the certificate being valid in seconds
- */
- validExpiry: number;
- /**
- * Start date of the certificate being valid in seconds
- */
- validStart: number;
- }
-
- interface CertificatePrincipal {
-
- // Docs: http://electronjs.org/docs/api/structures/certificate-principal
-
- /**
- * Common Name.
- */
- commonName: string;
- /**
- * Country or region.
- */
- country: string;
- /**
- * Locality.
- */
- locality: string;
- /**
- * Organization names.
- */
- organizations: string[];
- /**
- * Organization Unit names.
- */
- organizationUnits: string[];
- /**
- * State or province.
- */
- state: string;
- }
-
- class ClientRequest extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/client-request
-
- /**
- * Emitted when the `request` is aborted. The `abort` event will not be fired if
- * the `request` is already closed.
- */
- on(event: 'abort', listener: Function): this;
- once(event: 'abort', listener: Function): this;
- addListener(event: 'abort', listener: Function): this;
- removeListener(event: 'abort', listener: Function): this;
- /**
- * Emitted as the last event in the HTTP request-response transaction. The `close`
- * event indicates that no more events will be emitted on either the `request` or
- * `response` objects.
- */
- on(event: 'close', listener: Function): this;
- once(event: 'close', listener: Function): this;
- addListener(event: 'close', listener: Function): this;
- removeListener(event: 'close', listener: Function): this;
- /**
- * Emitted when the `net` module fails to issue a network request. Typically when
- * the `request` object emits an `error` event, a `close` event will subsequently
- * follow and no response object will be provided.
- */
- on(event: 'error', listener: (
- /**
- * an error object providing some information about the failure.
- */
- error: Error) => void): this;
- once(event: 'error', listener: (
- /**
- * an error object providing some information about the failure.
- */
- error: Error) => void): this;
- addListener(event: 'error', listener: (
- /**
- * an error object providing some information about the failure.
- */
- error: Error) => void): this;
- removeListener(event: 'error', listener: (
- /**
- * an error object providing some information about the failure.
- */
- error: Error) => void): this;
- /**
- * Emitted just after the last chunk of the `request`'s data has been written into
- * the `request` object.
- */
- on(event: 'finish', listener: Function): this;
- once(event: 'finish', listener: Function): this;
- addListener(event: 'finish', listener: Function): this;
- removeListener(event: 'finish', listener: Function): this;
- /**
- * Emitted when an authenticating proxy is asking for user credentials.
- *
- * The `callback` function is expected to be called back with user credentials:
- *
- * * `username` String
- * * `password` String
- *
- * Providing empty credentials will cancel the request and report an authentication
- * error on the response object:
- */
- on(event: 'login', listener: (authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- once(event: 'login', listener: (authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- addListener(event: 'login', listener: (authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- removeListener(event: 'login', listener: (authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- /**
- * Emitted when there is redirection and the mode is `manual`. Calling
- * `request.followRedirect` will continue with the redirection.
- */
- on(event: 'redirect', listener: (statusCode: number,
- method: string,
- redirectUrl: string,
- responseHeaders: Record) => void): this;
- once(event: 'redirect', listener: (statusCode: number,
- method: string,
- redirectUrl: string,
- responseHeaders: Record) => void): this;
- addListener(event: 'redirect', listener: (statusCode: number,
- method: string,
- redirectUrl: string,
- responseHeaders: Record) => void): this;
- removeListener(event: 'redirect', listener: (statusCode: number,
- method: string,
- redirectUrl: string,
- responseHeaders: Record) => void): this;
- on(event: 'response', listener: (
- /**
- * An object representing the HTTP response message.
- */
- response: IncomingMessage) => void): this;
- once(event: 'response', listener: (
- /**
- * An object representing the HTTP response message.
- */
- response: IncomingMessage) => void): this;
- addListener(event: 'response', listener: (
- /**
- * An object representing the HTTP response message.
- */
- response: IncomingMessage) => void): this;
- removeListener(event: 'response', listener: (
- /**
- * An object representing the HTTP response message.
- */
- response: IncomingMessage) => void): this;
- /**
- * ClientRequest
- */
- constructor(options: (ClientRequestConstructorOptions) | (string));
- /**
- * Cancels an ongoing HTTP transaction. If the request has already emitted the
- * `close` event, the abort operation will have no effect. Otherwise an ongoing
- * event will emit `abort` and `close` events. Additionally, if there is an ongoing
- * response object,it will emit the `aborted` event.
- */
- abort(): void;
- /**
- * Sends the last chunk of the request data. Subsequent write or end operations
- * will not be allowed. The `finish` event is emitted just after the end operation.
- */
- end(chunk?: (string) | (Buffer), encoding?: string, callback?: () => void): void;
- /**
- * Continues any deferred redirection request when the redirection mode is
- * `manual`.
- */
- followRedirect(): void;
- /**
- * The value of a previously set extra header name.
- */
- getHeader(name: string): string;
- /**
- * * `active` Boolean - Whether the request is currently active. If this is false
- * no other properties will be set
- * * `started` Boolean - Whether the upload has started. If this is false both
- * `current` and `total` will be set to 0.
- * * `current` Integer - The number of bytes that have been uploaded so far
- * * `total` Integer - The number of bytes that will be uploaded this request
- *
- * You can use this method in conjunction with `POST` requests to get the progress
- * of a file upload or other data transfer.
- */
- getUploadProgress(): UploadProgress;
- /**
- * Removes a previously set extra header name. This method can be called only
- * before first write. Trying to call it after the first write will throw an error.
- */
- removeHeader(name: string): void;
- /**
- * Adds an extra HTTP header. The header name will be issued as-is without
- * lowercasing. It can be called only before first write. Calling this method after
- * the first write will throw an error. If the passed value is not a `String`, its
- * `toString()` method will be called to obtain the final value.
- */
- setHeader(name: string, value: string): void;
- /**
- * `callback` is essentially a dummy function introduced in the purpose of keeping
- * similarity with the Node.js API. It is called asynchronously in the next tick
- * after `chunk` content have been delivered to the Chromium networking layer.
- * Contrary to the Node.js implementation, it is not guaranteed that `chunk`
- * content have been flushed on the wire before `callback` is called.
- *
- * Adds a chunk of data to the request body. The first write operation may cause
- * the request headers to be issued on the wire. After the first write operation,
- * it is not allowed to add or remove a custom header.
- */
- write(chunk: (string) | (Buffer), encoding?: string, callback?: () => void): void;
- chunkedEncoding: boolean;
- }
-
- interface Clipboard {
-
- // Docs: http://electronjs.org/docs/api/clipboard
-
- /**
- * An array of supported formats for the clipboard `type`.
- */
- availableFormats(type?: 'selection' | 'clipboard'): string[];
- /**
- * Clears the clipboard content.
- */
- clear(type?: 'selection' | 'clipboard'): void;
- /**
- * Whether the clipboard supports the specified `format`.
- *
- * @experimental
- */
- has(format: string, type?: 'selection' | 'clipboard'): boolean;
- /**
- * Reads `format` type from the clipboard.
- *
- * @experimental
- */
- read(format: string): string;
- /**
- * * `title` String
- * * `url` String
- *
- * Returns an Object containing `title` and `url` keys representing the bookmark in
- * the clipboard. The `title` and `url` values will be empty strings when the
- * bookmark is unavailable.
- *
- * @platform darwin,win32
- */
- readBookmark(): ReadBookmark;
- /**
- * Reads `format` type from the clipboard.
- *
- * @experimental
- */
- readBuffer(format: string): Buffer;
- /**
- * The text on the find pasteboard, which is the pasteboard that holds information
- * about the current state of the active application’s find panel.
- *
- * This method uses synchronous IPC when called from the renderer process. The
- * cached value is reread from the find pasteboard whenever the application is
- * activated.
- *
- * @platform darwin
- */
- readFindText(): string;
- /**
- * The content in the clipboard as markup.
- */
- readHTML(type?: 'selection' | 'clipboard'): string;
- /**
- * The image content in the clipboard.
- */
- readImage(type?: 'selection' | 'clipboard'): NativeImage;
- /**
- * The content in the clipboard as RTF.
- */
- readRTF(type?: 'selection' | 'clipboard'): string;
- /**
- * The content in the clipboard as plain text.
- */
- readText(type?: 'selection' | 'clipboard'): string;
- /**
- * Writes `data` to the clipboard.
- */
- write(data: Data, type?: 'selection' | 'clipboard'): void;
- /**
- * Writes the `title` and `url` into the clipboard as a bookmark.
- *
- * **Note:** Most apps on Windows don't support pasting bookmarks into them so you
- * can use `clipboard.write` to write both a bookmark and fallback text to the
- * clipboard.
- *
- * @platform darwin,win32
- */
- writeBookmark(title: string, url: string, type?: 'selection' | 'clipboard'): void;
- /**
- * Writes the `buffer` into the clipboard as `format`.
- *
- * @experimental
- */
- writeBuffer(format: string, buffer: Buffer, type?: 'selection' | 'clipboard'): void;
- /**
- * Writes the `text` into the find pasteboard (the pasteboard that holds
- * information about the current state of the active application’s find panel) as
- * plain text. This method uses synchronous IPC when called from the renderer
- * process.
- *
- * @platform darwin
- */
- writeFindText(text: string): void;
- /**
- * Writes `markup` to the clipboard.
- */
- writeHTML(markup: string, type?: 'selection' | 'clipboard'): void;
- /**
- * Writes `image` to the clipboard.
- */
- writeImage(image: NativeImage, type?: 'selection' | 'clipboard'): void;
- /**
- * Writes the `text` into the clipboard in RTF.
- */
- writeRTF(text: string, type?: 'selection' | 'clipboard'): void;
- /**
- * Writes the `text` into the clipboard as plain text.
- */
- writeText(text: string, type?: 'selection' | 'clipboard'): void;
- }
-
- class CommandLine {
-
- // Docs: http://electronjs.org/docs/api/command-line
-
- /**
- * Append an argument to Chromium's command line. The argument will be quoted
- * correctly. Switches will precede arguments regardless of appending order.
- *
- * If you're appending an argument like `--switch=value`, consider using
- * `appendSwitch('switch', 'value')` instead.
- *
- * **Note:** This will not affect `process.argv`. The intended usage of this
- * function is to control Chromium's behavior.
- */
- appendArgument(value: string): void;
- /**
- * Append a switch (with optional `value`) to Chromium's command line.
- *
- * **Note:** This will not affect `process.argv`. The intended usage of this
- * function is to control Chromium's behavior.
- */
- appendSwitch(the_switch: string, value?: string): void;
- /**
- * The command-line switch value.
- *
- * **Note:** When the switch is not present or has no value, it returns empty
- * string.
- */
- getSwitchValue(the_switch: string): string;
- /**
- * Whether the command-line switch is present.
- */
- hasSwitch(the_switch: string): boolean;
- }
-
- interface ContentTracing {
-
- // Docs: http://electronjs.org/docs/api/content-tracing
-
- /**
- * resolves with an array of category groups once all child processes have
- * acknowledged the `getCategories` request
- *
- * Get a set of category groups. The category groups can change as new code paths
- * are reached. See also the list of built-in tracing categories.
- */
- getCategories(): Promise;
- /**
- * Resolves with an object containing the `value` and `percentage` of trace buffer
- * maximum usage
- *
- * * `value` Number
- * * `percentage` Number
- *
- * Get the maximum usage across processes of trace buffer as a percentage of the
- * full state.
- */
- getTraceBufferUsage(): Promise;
- /**
- * resolved once all child processes have acknowledged the `startRecording`
- * request.
- *
- * Start recording on all processes.
- *
- * Recording begins immediately locally and asynchronously on child processes as
- * soon as they receive the EnableRecording request.
- *
- * If a recording is already running, the promise will be immediately resolved, as
- * only one trace operation can be in progress at a time.
- */
- startRecording(options: (TraceConfig) | (TraceCategoriesAndOptions)): Promise;
- /**
- * resolves with a path to a file that contains the traced data once all child
- * processes have acknowledged the `stopRecording` request
- *
- * Stop recording on all processes.
- *
- * Child processes typically cache trace data and only rarely flush and send trace
- * data back to the main process. This helps to minimize the runtime overhead of
- * tracing since sending trace data over IPC can be an expensive operation. So, to
- * end tracing, Chromium asynchronously asks all child processes to flush any
- * pending trace data.
- *
- * Trace data will be written into `resultFilePath`. If `resultFilePath` is empty
- * or not provided, trace data will be written to a temporary file, and the path
- * will be returned in the promise.
- */
- stopRecording(resultFilePath?: string): Promise;
- }
-
- interface Cookie {
-
- // Docs: http://electronjs.org/docs/api/structures/cookie
-
- /**
- * The domain of the cookie; this will be normalized with a preceding dot so that
- * it's also valid for subdomains.
- */
- domain?: string;
- /**
- * The expiration date of the cookie as the number of seconds since the UNIX epoch.
- * Not provided for session cookies.
- */
- expirationDate?: number;
- /**
- * Whether the cookie is a host-only cookie; this will only be `true` if no domain
- * was passed.
- */
- hostOnly?: boolean;
- /**
- * Whether the cookie is marked as HTTP only.
- */
- httpOnly?: boolean;
- /**
- * The name of the cookie.
- */
- name: string;
- /**
- * The path of the cookie.
- */
- path?: string;
- /**
- * Whether the cookie is marked as secure.
- */
- secure?: boolean;
- /**
- * Whether the cookie is a session cookie or a persistent cookie with an expiration
- * date.
- */
- session?: boolean;
- /**
- * The value of the cookie.
- */
- value: string;
- }
-
- class Cookies extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/cookies
-
- /**
- * Emitted when a cookie is changed because it was added, edited, removed, or
- * expired.
- */
- on(event: 'changed', listener: Function): this;
- once(event: 'changed', listener: Function): this;
- addListener(event: 'changed', listener: Function): this;
- removeListener(event: 'changed', listener: Function): this;
- /**
- * A promise which resolves when the cookie store has been flushed
- *
-Writes any unwritten cookies data to disk.
- */
- flushStore(): Promise;
- /**
- * A promise which resolves an array of cookie objects.
- *
- * Sends a request to get all cookies matching `filter`, and resolves a promise
- * with the response.
- */
- get(filter: Filter): Promise;
- /**
- * A promise which resolves when the cookie has been removed
- *
-Removes the cookies matching `url` and `name`
- */
- remove(url: string, name: string): Promise;
- /**
- * A promise which resolves when the cookie has been set
- *
-Sets a cookie with `details`.
- */
- set(details: Details): Promise;
- }
-
- interface CPUUsage {
-
- // Docs: http://electronjs.org/docs/api/structures/cpu-usage
-
- /**
- * The number of average idle CPU wakeups per second since the last call to
- * getCPUUsage. First call returns 0. Will always return 0 on Windows.
- */
- idleWakeupsPerSecond: number;
- /**
- * Percentage of CPU used since the last call to getCPUUsage. First call returns 0.
- */
- percentCPUUsage: number;
- }
-
- interface CrashReport {
-
- // Docs: http://electronjs.org/docs/api/structures/crash-report
-
- date: Date;
- id: string;
- }
-
- interface CrashReporter {
-
- // Docs: http://electronjs.org/docs/api/crash-reporter
-
- /**
- * Set an extra parameter to be sent with the crash report. The values specified
- * here will be sent in addition to any values set via the `extra` option when
- * `start` was called. This API is only available on macOS and windows, if you need
- * to add/update extra parameters on Linux after your first call to `start` you can
- * call `start` again with the updated `extra` options.
- *
- * @platform darwin,win32
- */
- addExtraParameter(key: string, value: string): void;
- /**
- * Returns the date and ID of the last crash report. Only crash reports that have
- * been uploaded will be returned; even if a crash report is present on disk it
- * will not be returned until it is uploaded. In the case that there are no
- * uploaded reports, `null` is returned.
- */
- getLastCrashReport(): CrashReport;
- /**
- * See all of the current parameters being passed to the crash reporter.
- */
- getParameters(): void;
- /**
- * Returns all uploaded crash reports. Each report contains the date and uploaded
- * ID.
- */
- getUploadedReports(): CrashReport[];
- /**
- * Whether reports should be submitted to the server. Set through the `start`
- * method or `setUploadToServer`.
- *
-**Note:** This API can only be called from the main process.
- */
- getUploadToServer(): boolean;
- /**
- * Remove a extra parameter from the current set of parameters so that it will not
- * be sent with the crash report.
- *
- * @platform darwin,win32
- */
- removeExtraParameter(key: string): void;
- /**
- * This would normally be controlled by user preferences. This has no effect if
- * called before `start` is called.
- *
-**Note:** This API can only be called from the main process.
- */
- setUploadToServer(uploadToServer: boolean): void;
- /**
- * You are required to call this method before using any other `crashReporter` APIs
- * and in each process (main/renderer) from which you want to collect crash
- * reports. You can pass different options to `crashReporter.start` when calling
- * from different processes.
- *
- * **Note** Child processes created via the `child_process` module will not have
- * access to the Electron modules. Therefore, to collect crash reports from them,
- * use `process.crashReporter.start` instead. Pass the same options as above along
- * with an additional one called `crashesDirectory` that should point to a
- * directory to store the crash reports temporarily. You can test this out by
- * calling `process.crash()` to crash the child process.
- *
- * **Note:** If you need send additional/updated `extra` parameters after your
- * first call `start` you can call `addExtraParameter` on macOS or call `start`
- * again with the new/updated `extra` parameters on Linux and Windows.
- *
- * **Note:** On macOS and windows, Electron uses a new `crashpad` client for crash
- * collection and reporting. If you want to enable crash reporting, initializing
- * `crashpad` from the main process using `crashReporter.start` is required
- * regardless of which process you want to collect crashes from. Once initialized
- * this way, the crashpad handler collects crashes from all processes. You still
- * have to call `crashReporter.start` from the renderer or child process, otherwise
- * crashes from them will get reported without `companyName`, `productName` or any
- * of the `extra` information.
- */
- start(options: CrashReporterStartOptions): void;
- }
-
- interface CustomScheme {
-
- // Docs: http://electronjs.org/docs/api/structures/custom-scheme
-
- privileges?: Privileges;
- /**
- * Custom schemes to be registered with options.
- */
- scheme: string;
- }
-
- class Debugger extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/debugger
-
- /**
- * Emitted when the debugging session is terminated. This happens either when
- * `webContents` is closed or devtools is invoked for the attached `webContents`.
- */
- on(event: 'detach', listener: (event: Event,
- /**
- * Reason for detaching debugger.
- */
- reason: string) => void): this;
- once(event: 'detach', listener: (event: Event,
- /**
- * Reason for detaching debugger.
- */
- reason: string) => void): this;
- addListener(event: 'detach', listener: (event: Event,
- /**
- * Reason for detaching debugger.
- */
- reason: string) => void): this;
- removeListener(event: 'detach', listener: (event: Event,
- /**
- * Reason for detaching debugger.
- */
- reason: string) => void): this;
- /**
- * Emitted whenever the debugging target issues an instrumentation event.
- */
- on(event: 'message', listener: (event: Event,
- /**
- * Method name.
- */
- method: string,
- /**
- * Event parameters defined by the 'parameters' attribute in the remote debugging
- * protocol.
- */
- params: unknown) => void): this;
- once(event: 'message', listener: (event: Event,
- /**
- * Method name.
- */
- method: string,
- /**
- * Event parameters defined by the 'parameters' attribute in the remote debugging
- * protocol.
- */
- params: unknown) => void): this;
- addListener(event: 'message', listener: (event: Event,
- /**
- * Method name.
- */
- method: string,
- /**
- * Event parameters defined by the 'parameters' attribute in the remote debugging
- * protocol.
- */
- params: unknown) => void): this;
- removeListener(event: 'message', listener: (event: Event,
- /**
- * Method name.
- */
- method: string,
- /**
- * Event parameters defined by the 'parameters' attribute in the remote debugging
- * protocol.
- */
- params: unknown) => void): this;
- /**
- * Attaches the debugger to the `webContents`.
- */
- attach(protocolVersion?: string): void;
- /**
- * Detaches the debugger from the `webContents`.
- */
- detach(): void;
- /**
- * Whether a debugger is attached to the `webContents`.
- */
- isAttached(): boolean;
- /**
- * A promise that resolves with the response defined by the 'returns' attribute of
- * the command description in the remote debugging protocol or is rejected
- * indicating the failure of the command.
- *
-Send given command to the debugging target.
- */
- sendCommand(method: string, commandParams?: any): Promise;
- }
-
- interface DesktopCapturer {
-
- // Docs: http://electronjs.org/docs/api/desktop-capturer
-
- /**
- * Resolves with an array of `DesktopCapturerSource` objects, each
- * `DesktopCapturerSource` represents a screen or an individual window that can be
- * captured.
- */
- getSources(options: SourcesOptions): Promise;
- }
-
- interface DesktopCapturerSource {
-
- // Docs: http://electronjs.org/docs/api/structures/desktop-capturer-source
-
- /**
- * An icon image of the application that owns the window or null if the source has
- * a type screen. The size of the icon is not known in advance and depends on what
- * the the application provides.
- */
- appIcon: NativeImage;
- /**
- * A unique identifier that will correspond to the `id` of the matching Display
- * returned by the Screen API. On some platforms, this is equivalent to the `XX`
- * portion of the `id` field above and on others it will differ. It will be an
- * empty string if not available.
- */
- display_id: string;
- /**
- * The identifier of a window or screen that can be used as a `chromeMediaSourceId`
- * constraint when calling [`navigator.webkitGetUserMedia`]. The format of the
- * identifier will be `window:XX` or `screen:XX`, where `XX` is a random generated
- * number.
- */
- id: string;
- /**
- * A screen source will be named either `Entire Screen` or `Screen `, while
- * the name of a window source will match the window title.
- */
- name: string;
- /**
- * A thumbnail image. **Note:** There is no guarantee that the size of the
- * thumbnail is the same as the `thumbnailSize` specified in the `options` passed
- * to `desktopCapturer.getSources`. The actual size depends on the scale of the
- * screen or window.
- */
- thumbnail: NativeImage;
- }
-
- interface Dialog {
-
- // Docs: http://electronjs.org/docs/api/dialog
-
- /**
- * resolves when the certificate trust dialog is shown.
- *
- * On macOS, this displays a modal dialog that shows a message and certificate
- * information, and gives the user the option of trusting/importing the
- * certificate. If you provide a `browserWindow` argument the dialog will be
- * attached to the parent window, making it modal.
- *
- * On Windows the options are more limited, due to the Win32 APIs used:
- *
- * * The `message` argument is not used, as the OS provides its own confirmation
- * dialog.
- * * The `browserWindow` argument is ignored since it is not possible to make this
- * confirmation dialog modal.
- *
- * @platform darwin,win32
- */
- showCertificateTrustDialog(browserWindow: BrowserWindow, options: CertificateTrustDialogOptions): Promise;
- /**
- * resolves when the certificate trust dialog is shown.
- *
- * On macOS, this displays a modal dialog that shows a message and certificate
- * information, and gives the user the option of trusting/importing the
- * certificate. If you provide a `browserWindow` argument the dialog will be
- * attached to the parent window, making it modal.
- *
- * On Windows the options are more limited, due to the Win32 APIs used:
- *
- * * The `message` argument is not used, as the OS provides its own confirmation
- * dialog.
- * * The `browserWindow` argument is ignored since it is not possible to make this
- * confirmation dialog modal.
- *
- * @platform darwin,win32
- */
- showCertificateTrustDialog(options: CertificateTrustDialogOptions): Promise;
- /**
- * Displays a modal dialog that shows an error message.
- *
- * This API can be called safely before the `ready` event the `app` module emits,
- * it is usually used to report errors in early stage of startup. If called before
- * the app `ready`event on Linux, the message will be emitted to stderr, and no GUI
- * dialog will appear.
- */
- showErrorBox(title: string, content: string): void;
- /**
- * resolves with a promise containing the following properties:
- *
- * * `response` Number - The index of the clicked button.
- * * `checkboxChecked` Boolean - The checked state of the checkbox if
- * `checkboxLabel` was set. Otherwise `false`.
- *
- * Shows a message box, it will block the process until the message box is closed.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- */
- showMessageBox(browserWindow: BrowserWindow, options: MessageBoxOptions): Promise;
- /**
- * resolves with a promise containing the following properties:
- *
- * * `response` Number - The index of the clicked button.
- * * `checkboxChecked` Boolean - The checked state of the checkbox if
- * `checkboxLabel` was set. Otherwise `false`.
- *
- * Shows a message box, it will block the process until the message box is closed.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- */
- showMessageBox(options: MessageBoxOptions): Promise;
- /**
- * the index of the clicked button.
- *
- * Shows a message box, it will block the process until the message box is closed.
- * It returns the index of the clicked button.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- */
- showMessageBoxSync(browserWindow: BrowserWindow, options: MessageBoxSyncOptions): number;
- /**
- * the index of the clicked button.
- *
- * Shows a message box, it will block the process until the message box is closed.
- * It returns the index of the clicked button.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- */
- showMessageBoxSync(options: MessageBoxSyncOptions): number;
- /**
- * Resolve with an object containing the following:
- *
- * * `canceled` Boolean - whether or not the dialog was canceled.
- * * `filePaths` String[] - An array of file paths chosen by the user. If the
- * dialog is cancelled this will be an empty array.
- * * `bookmarks` String[] (optional) _macOS_ _mas_ - An array matching the
- * `filePaths` array of base64 encoded strings which contains security scoped
- * bookmark data. `securityScopedBookmarks` must be enabled for this to be
- * populated.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- *
- * The `filters` specifies an array of file types that can be displayed or selected
- * when you want to limit the user to a specific type. For example:
- *
- * The `extensions` array should contain extensions without wildcards or dots (e.g.
- * `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the
- * `'*'` wildcard (no other wildcard is supported).
- *
- * **Note:** On Windows and Linux an open dialog can not be both a file selector
- * and a directory selector, so if you set `properties` to `['openFile',
- * 'openDirectory']` on these platforms, a directory selector will be shown.
- */
- showOpenDialog(browserWindow: BrowserWindow, options: OpenDialogOptions): Promise;
- /**
- * Resolve with an object containing the following:
- *
- * * `canceled` Boolean - whether or not the dialog was canceled.
- * * `filePaths` String[] - An array of file paths chosen by the user. If the
- * dialog is cancelled this will be an empty array.
- * * `bookmarks` String[] (optional) _macOS_ _mas_ - An array matching the
- * `filePaths` array of base64 encoded strings which contains security scoped
- * bookmark data. `securityScopedBookmarks` must be enabled for this to be
- * populated.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- *
- * The `filters` specifies an array of file types that can be displayed or selected
- * when you want to limit the user to a specific type. For example:
- *
- * The `extensions` array should contain extensions without wildcards or dots (e.g.
- * `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the
- * `'*'` wildcard (no other wildcard is supported).
- *
- * **Note:** On Windows and Linux an open dialog can not be both a file selector
- * and a directory selector, so if you set `properties` to `['openFile',
- * 'openDirectory']` on these platforms, a directory selector will be shown.
- */
- showOpenDialog(options: OpenDialogOptions): Promise;
- /**
- * the file paths chosen by the user; if the dialog is cancelled it returns
- * `undefined`.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- *
- * The `filters` specifies an array of file types that can be displayed or selected
- * when you want to limit the user to a specific type. For example:
- *
- * The `extensions` array should contain extensions without wildcards or dots (e.g.
- * `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the
- * `'*'` wildcard (no other wildcard is supported).
- *
- * **Note:** On Windows and Linux an open dialog can not be both a file selector
- * and a directory selector, so if you set `properties` to `['openFile',
- * 'openDirectory']` on these platforms, a directory selector will be shown.
- */
- showOpenDialogSync(browserWindow: BrowserWindow, options: OpenDialogSyncOptions): (string[]) | (undefined);
- /**
- * the file paths chosen by the user; if the dialog is cancelled it returns
- * `undefined`.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- *
- * The `filters` specifies an array of file types that can be displayed or selected
- * when you want to limit the user to a specific type. For example:
- *
- * The `extensions` array should contain extensions without wildcards or dots (e.g.
- * `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the
- * `'*'` wildcard (no other wildcard is supported).
- *
- * **Note:** On Windows and Linux an open dialog can not be both a file selector
- * and a directory selector, so if you set `properties` to `['openFile',
- * 'openDirectory']` on these platforms, a directory selector will be shown.
- */
- showOpenDialogSync(options: OpenDialogSyncOptions): (string[]) | (undefined);
- /**
- * Resolve with an object containing the following:
- *
- * * `canceled` Boolean - whether or not the dialog was canceled.
- * * `filePath` String (optional) - If the dialog is canceled, this will be
- * `undefined`.
- * * `bookmark` String (optional) _macOS_ _mas_ - Base64 encoded string which
- * contains the security scoped bookmark data for the saved file.
- * `securityScopedBookmarks` must be enabled for this to be present.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- *
- * The `filters` specifies an array of file types that can be displayed, see
- * `dialog.showOpenDialog` for an example.
- *
- * **Note:** On macOS, using the asynchronous version is recommended to avoid
- * issues when expanding and collapsing the dialog.
- */
- showSaveDialog(browserWindow: BrowserWindow, options: SaveDialogOptions): Promise;
- /**
- * Resolve with an object containing the following:
- *
- * * `canceled` Boolean - whether or not the dialog was canceled.
- * * `filePath` String (optional) - If the dialog is canceled, this will be
- * `undefined`.
- * * `bookmark` String (optional) _macOS_ _mas_ - Base64 encoded string which
- * contains the security scoped bookmark data for the saved file.
- * `securityScopedBookmarks` must be enabled for this to be present.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- *
- * The `filters` specifies an array of file types that can be displayed, see
- * `dialog.showOpenDialog` for an example.
- *
- * **Note:** On macOS, using the asynchronous version is recommended to avoid
- * issues when expanding and collapsing the dialog.
- */
- showSaveDialog(options: SaveDialogOptions): Promise;
- /**
- * the path of the file chosen by the user; if the dialog is cancelled it returns
- * `undefined`.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- *
- * The `filters` specifies an array of file types that can be displayed, see
- * `dialog.showOpenDialog` for an example.
- */
- showSaveDialogSync(browserWindow: BrowserWindow, options: SaveDialogSyncOptions): (string) | (undefined);
- /**
- * the path of the file chosen by the user; if the dialog is cancelled it returns
- * `undefined`.
- *
- * The `browserWindow` argument allows the dialog to attach itself to a parent
- * window, making it modal.
- *
- * The `filters` specifies an array of file types that can be displayed, see
- * `dialog.showOpenDialog` for an example.
- */
- showSaveDialogSync(options: SaveDialogSyncOptions): (string) | (undefined);
- }
-
- interface Display {
-
- // Docs: http://electronjs.org/docs/api/structures/display
-
- /**
- * Can be `available`, `unavailable`, `unknown`.
- */
- accelerometerSupport: ('available' | 'unavailable' | 'unknown');
- bounds: Rectangle;
- /**
- * The number of bits per pixel.
- */
- colorDepth: number;
- /**
- * represent a color space (three-dimensional object which contains all realizable
- * color combinations) for the purpose of color conversions
- */
- colorSpace: string;
- /**
- * The number of bits per color component.
- */
- depthPerComponent: number;
- /**
- * Unique identifier associated with the display.
- */
- id: number;
- /**
- * `true` for an internal display and `false` for an external display
- */
- internal: boolean;
- /**
- * Whether or not the display is a monochrome display.
- */
- monochrome: boolean;
- /**
- * Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees.
- */
- rotation: number;
- /**
- * Output device's pixel scale factor.
- */
- scaleFactor: number;
- size: Size;
- /**
- * Can be `available`, `unavailable`, `unknown`.
- */
- touchSupport: ('available' | 'unavailable' | 'unknown');
- workArea: Rectangle;
- workAreaSize: Size;
- }
-
- class Dock {
-
- // Docs: http://electronjs.org/docs/api/dock
-
- /**
- * an ID representing the request.
- *
- * When `critical` is passed, the dock icon will bounce until either the
- * application becomes active or the request is canceled.
- *
- * When `informational` is passed, the dock icon will bounce for one second.
- * However, the request remains active until either the application becomes active
- * or the request is canceled.
- *
- * **Nota Bene:** This method can only be used while the app is not focused; when
- * the app is focused it will return -1.
- *
- * @platform darwin
- */
- bounce(type?: 'critical' | 'informational'): number;
- /**
- * Cancel the bounce of `id`.
- *
- * @platform darwin
- */
- cancelBounce(id: number): void;
- /**
- * Bounces the Downloads stack if the filePath is inside the Downloads folder.
- *
- * @platform darwin
- */
- downloadFinished(filePath: string): void;
- /**
- * The badge string of the dock.
- *
- * @platform darwin
- */
- getBadge(): string;
- /**
- * The application's [dock menu][dock-menu].
- *
- * @platform darwin
- */
- getMenu(): (Menu) | (null);
- /**
- * Hides the dock icon.
- *
- * @platform darwin
- */
- hide(): void;
- /**
- * Whether the dock icon is visible.
- *
- * @platform darwin
- */
- isVisible(): boolean;
- /**
- * Sets the string to be displayed in the dock’s badging area.
- *
- * @platform darwin
- */
- setBadge(text: string): void;
- /**
- * Sets the `image` associated with this dock icon.
- *
- * @platform darwin
- */
- setIcon(image: (NativeImage) | (string)): void;
- /**
- * Sets the application's [dock menu][dock-menu].
- *
- * @platform darwin
- */
- setMenu(menu: Menu): void;
- /**
- * Resolves when the dock icon is shown.
- *
- * @platform darwin
- */
- show(): Promise;
- }
-
- class DownloadItem extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/download-item
-
- /**
- * Emitted when the download is in a terminal state. This includes a completed
- * download, a cancelled download (via `downloadItem.cancel()`), and interrupted
- * download that can't be resumed.
- *
- * The `state` can be one of following:
- *
- * * `completed` - The download completed successfully.
- * * `cancelled` - The download has been cancelled.
- * * `interrupted` - The download has interrupted and can not resume.
- */
- on(event: 'done', listener: (event: Event,
- /**
- * Can be `completed`, `cancelled` or `interrupted`.
- */
- state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
- once(event: 'done', listener: (event: Event,
- /**
- * Can be `completed`, `cancelled` or `interrupted`.
- */
- state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
- addListener(event: 'done', listener: (event: Event,
- /**
- * Can be `completed`, `cancelled` or `interrupted`.
- */
- state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
- removeListener(event: 'done', listener: (event: Event,
- /**
- * Can be `completed`, `cancelled` or `interrupted`.
- */
- state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
- /**
- * Emitted when the download has been updated and is not done.
- *
- * The `state` can be one of following:
- *
- * * `progressing` - The download is in-progress.
- * * `interrupted` - The download has interrupted and can be resumed.
- */
- on(event: 'updated', listener: (event: Event,
- /**
- * Can be `progressing` or `interrupted`.
- */
- state: ('progressing' | 'interrupted')) => void): this;
- once(event: 'updated', listener: (event: Event,
- /**
- * Can be `progressing` or `interrupted`.
- */
- state: ('progressing' | 'interrupted')) => void): this;
- addListener(event: 'updated', listener: (event: Event,
- /**
- * Can be `progressing` or `interrupted`.
- */
- state: ('progressing' | 'interrupted')) => void): this;
- removeListener(event: 'updated', listener: (event: Event,
- /**
- * Can be `progressing` or `interrupted`.
- */
- state: ('progressing' | 'interrupted')) => void): this;
- /**
- * Cancels the download operation.
- */
- cancel(): void;
- /**
- * Whether the download can resume.
- */
- canResume(): boolean;
- /**
- * The Content-Disposition field from the response header.
- */
- getContentDisposition(): string;
- /**
- * ETag header value.
- */
- getETag(): string;
- /**
- * The file name of the download item.
- *
- * **Note:** The file name is not always the same as the actual one saved in local
- * disk. If user changes the file name in a prompted download saving dialog, the
- * actual name of saved file will be different.
- */
- getFilename(): string;
- /**
- * Last-Modified header value.
- */
- getLastModifiedTime(): string;
- /**
- * The files mime type.
- */
- getMimeType(): string;
- /**
- * The received bytes of the download item.
- */
- getReceivedBytes(): number;
- /**
- * Returns the object previously set by
- * `downloadItem.setSaveDialogOptions(options)`.
- */
- getSaveDialogOptions(): SaveDialogOptions;
- /**
- * The save path of the download item. This will be either the path set via
- * `downloadItem.setSavePath(path)` or the path selected from the shown save
- * dialog.
-
-**Deprecated: use the `savePath` property instead.**
- */
- getSavePath(): string;
- /**
- * Number of seconds since the UNIX epoch when the download was started.
- */
- getStartTime(): number;
- /**
- * The current state. Can be `progressing`, `completed`, `cancelled` or
- * `interrupted`.
- *
- * **Note:** The following methods are useful specifically to resume a `cancelled`
- * item when session is restarted.
- */
- getState(): ('progressing' | 'completed' | 'cancelled' | 'interrupted');
- /**
- * The total size in bytes of the download item.
- *
-If the size is unknown, it returns 0.
- */
- getTotalBytes(): number;
- /**
- * The origin URL where the item is downloaded from.
- */
- getURL(): string;
- /**
- * The complete URL chain of the item including any redirects.
- */
- getURLChain(): string[];
- /**
- * Whether the download has user gesture.
- */
- hasUserGesture(): boolean;
- /**
- * Whether the download is paused.
- */
- isPaused(): boolean;
- /**
- * Pauses the download.
- */
- pause(): void;
- /**
- * Resumes the download that has been paused.
- *
- * **Note:** To enable resumable downloads the server you are downloading from must
- * support range requests and provide both `Last-Modified` and `ETag` header
- * values. Otherwise `resume()` will dismiss previously received bytes and restart
- * the download from the beginning.
- */
- resume(): void;
- /**
- * This API allows the user to set custom options for the save dialog that opens
- * for the download item by default. The API is only available in session's
- * `will-download` callback function.
- */
- setSaveDialogOptions(options: SaveDialogOptions): void;
- /**
- * The API is only available in session's `will-download` callback function. If
- * user doesn't set the save path via the API, Electron will use the original
- * routine to determine the save path; this usually prompts a save dialog.
- *
-**Deprecated: use the `savePath` property instead.**
- */
- setSavePath(path: string): void;
- savePath: string;
- }
-
- interface Event extends GlobalEvent {
-
- // Docs: http://electronjs.org/docs/api/structures/event
-
- preventDefault: (() => void);
- }
-
- interface ExtensionInfo {
-
- // Docs: http://electronjs.org/docs/api/structures/extension-info
-
- name: string;
- version: string;
- }
-
- interface FileFilter {
-
- // Docs: http://electronjs.org/docs/api/structures/file-filter
-
- extensions: string[];
- name: string;
- }
-
- interface FilePathWithHeaders {
-
- // Docs: http://electronjs.org/docs/api/structures/file-path-with-headers
-
- /**
- * Additional headers to be sent.
- */
- headers?: Record;
- /**
- * The path to the file to send.
- */
- path: string;
- }
-
- interface GlobalShortcut {
-
- // Docs: http://electronjs.org/docs/api/global-shortcut
-
- /**
- * Whether this application has registered `accelerator`.
- *
- * When the accelerator is already taken by other applications, this call will
- * still return `false`. This behavior is intended by operating systems, since they
- * don't want applications to fight for global shortcuts.
- */
- isRegistered(accelerator: Accelerator): boolean;
- /**
- * Whether or not the shortcut was registered successfully.
- *
- * Registers a global shortcut of `accelerator`. The `callback` is called when the
- * registered shortcut is pressed by the user.
- *
- * When the accelerator is already taken by other applications, this call will
- * silently fail. This behavior is intended by operating systems, since they don't
- * want applications to fight for global shortcuts.
- *
- * The following accelerators will not be registered successfully on macOS 10.14
- * Mojave unless the app has been authorized as a trusted accessibility client:
- *
- * * "Media Play/Pause"
- * * "Media Next Track"
-* "Media Previous Track"
-* "Media Stop"
- */
- register(accelerator: Accelerator, callback: () => void): boolean;
- /**
- * Registers a global shortcut of all `accelerator` items in `accelerators`. The
- * `callback` is called when any of the registered shortcuts are pressed by the
- * user.
- *
- * When a given accelerator is already taken by other applications, this call will
- * silently fail. This behavior is intended by operating systems, since they don't
- * want applications to fight for global shortcuts.
- *
- * The following accelerators will not be registered successfully on macOS 10.14
- * Mojave unless the app has been authorized as a trusted accessibility client:
- *
- * * "Media Play/Pause"
- * * "Media Next Track"
-* "Media Previous Track"
-* "Media Stop"
- */
- registerAll(accelerators: string[], callback: () => void): void;
- /**
- * Unregisters the global shortcut of `accelerator`.
- */
- unregister(accelerator: Accelerator): void;
- /**
- * Unregisters all of the global shortcuts.
- */
- unregisterAll(): void;
- }
-
- interface GPUFeatureStatus {
-
- // Docs: http://electronjs.org/docs/api/structures/gpu-feature-status
-
- /**
- * Canvas.
- */
- '2d_canvas': string;
- /**
- * Flash.
- */
- flash_3d: string;
- /**
- * Flash Stage3D.
- */
- flash_stage3d: string;
- /**
- * Flash Stage3D Baseline profile.
- */
- flash_stage3d_baseline: string;
- /**
- * Compositing.
- */
- gpu_compositing: string;
- /**
- * Multiple Raster Threads.
- */
- multiple_raster_threads: string;
- /**
- * Native GpuMemoryBuffers.
- */
- native_gpu_memory_buffers: string;
- /**
- * Rasterization.
- */
- rasterization: string;
- /**
- * Video Decode.
- */
- video_decode: string;
- /**
- * Video Encode.
- */
- video_encode: string;
- /**
- * VPx Video Decode.
- */
- vpx_decode: string;
- /**
- * WebGL.
- */
- webgl: string;
- /**
- * WebGL2.
- */
- webgl2: string;
- }
-
- interface InAppPurchase extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/in-app-purchase
-
- on(event: 'transactions-updated', listener: Function): this;
- once(event: 'transactions-updated', listener: Function): this;
- addListener(event: 'transactions-updated', listener: Function): this;
- removeListener(event: 'transactions-updated', listener: Function): this;
- /**
- * whether a user can make a payment.
- */
- canMakePayments(): boolean;
- /**
- * Completes all pending transactions.
- */
- finishAllTransactions(): void;
- /**
- * Completes the pending transactions corresponding to the date.
- */
- finishTransactionByDate(date: string): void;
- /**
- * Resolves with an array of `Product` objects.
- *
-Retrieves the product descriptions.
- */
- getProducts(productIDs: string[]): Promise;
- /**
- * the path to the receipt.
- */
- getReceiptURL(): string;
- /**
- * Returns `true` if the product is valid and added to the payment queue.
- *
- * You should listen for the `transactions-updated` event as soon as possible and
- * certainly before you call `purchaseProduct`.
- */
- purchaseProduct(productID: string, quantity?: number): Promise;
- }
-
- class IncomingMessage extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/incoming-message
-
- /**
- * Emitted when a request has been canceled during an ongoing HTTP transaction.
- */
- on(event: 'aborted', listener: Function): this;
- once(event: 'aborted', listener: Function): this;
- addListener(event: 'aborted', listener: Function): this;
- removeListener(event: 'aborted', listener: Function): this;
- /**
- * The `data` event is the usual method of transferring response data into
- * applicative code.
- */
- on(event: 'data', listener: (
- /**
- * A chunk of response body's data.
- */
- chunk: Buffer) => void): this;
- once(event: 'data', listener: (
- /**
- * A chunk of response body's data.
- */
- chunk: Buffer) => void): this;
- addListener(event: 'data', listener: (
- /**
- * A chunk of response body's data.
- */
- chunk: Buffer) => void): this;
- removeListener(event: 'data', listener: (
- /**
- * A chunk of response body's data.
- */
- chunk: Buffer) => void): this;
- /**
- * Indicates that response body has ended.
- */
- on(event: 'end', listener: Function): this;
- once(event: 'end', listener: Function): this;
- addListener(event: 'end', listener: Function): this;
- removeListener(event: 'end', listener: Function): this;
- /**
- * Returns:
- *
- * `error` Error - Typically holds an error string identifying failure root cause.
- *
- * Emitted when an error was encountered while streaming response data events. For
- * instance, if the server closes the underlying while the response is still
- * streaming, an `error` event will be emitted on the response object and a `close`
- * event will subsequently follow on the request object.
- */
- on(event: 'error', listener: Function): this;
- once(event: 'error', listener: Function): this;
- addListener(event: 'error', listener: Function): this;
- removeListener(event: 'error', listener: Function): this;
- headers: Record;
- httpVersion: string;
- httpVersionMajor: number;
- httpVersionMinor: number;
- statusCode: number;
- statusMessage: string;
- }
-
- interface InputEvent {
-
- // Docs: http://electronjs.org/docs/api/structures/input-event
-
- /**
- * An array of modifiers of the event, can be `shift`, `control`, `alt`, `meta`,
- * `isKeypad`, `isAutoRepeat`, `leftButtonDown`, `middleButtonDown`,
- * `rightButtonDown`, `capsLock`, `numLock`, `left`, `right`.
- */
- modifiers: Array<'shift' | 'control' | 'alt' | 'meta' | 'isKeypad' | 'isAutoRepeat' | 'leftButtonDown' | 'middleButtonDown' | 'rightButtonDown' | 'capsLock' | 'numLock' | 'left' | 'right'>;
- }
-
- interface IOCounters {
-
- // Docs: http://electronjs.org/docs/api/structures/io-counters
-
- /**
- * Then number of I/O other operations.
- */
- otherOperationCount: number;
- /**
- * Then number of I/O other transfers.
- */
- otherTransferCount: number;
- /**
- * The number of I/O read operations.
- */
- readOperationCount: number;
- /**
- * The number of I/O read transfers.
- */
- readTransferCount: number;
- /**
- * The number of I/O write operations.
- */
- writeOperationCount: number;
- /**
- * The number of I/O write transfers.
- */
- writeTransferCount: number;
- }
-
- interface IpcMain extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/ipc-main
-
- /**
- * Adds a handler for an `invoke`able IPC. This handler will be called whenever a
- * renderer calls `ipcRenderer.invoke(channel, ...args)`.
- *
- * If `listener` returns a Promise, the eventual result of the promise will be
- * returned as a reply to the remote caller. Otherwise, the return value of the
- * listener will be used as the value of the reply.
- *
- * The `event` that is passed as the first argument to the handler is the same as
- * that passed to a regular event listener. It includes information about which
- * WebContents is the source of the invoke request.
- */
- handle(channel: string, listener: (event: IpcMainInvokeEvent, ...args: any[]) => (Promise) | (any)): void;
- /**
- * Handles a single `invoke`able IPC message, then removes the listener. See
- * `ipcMain.handle(channel, listener)`.
- */
- handleOnce(channel: string, listener: (event: IpcMainInvokeEvent, ...args: any[]) => (Promise) | (any)): void;
- /**
- * Listens to `channel`, when a new message arrives `listener` would be called with
- * `listener(event, args...)`.
- */
- on(channel: string, listener: (event: IpcMainEvent, ...args: any[]) => void): this;
- /**
- * Adds a one time `listener` function for the event. This `listener` is invoked
- * only the next time a message is sent to `channel`, after which it is removed.
- */
- once(channel: string, listener: (event: IpcMainEvent, ...args: any[]) => void): this;
- /**
- * Removes listeners of the specified `channel`.
- */
- removeAllListeners(channel?: string): this;
- /**
- * Removes any handler for `channel`, if present.
- */
- removeHandler(channel: string): void;
- /**
- * Removes the specified `listener` from the listener array for the specified
- * `channel`.
- */
- removeListener(channel: string, listener: () => void): this;
- }
-
- interface IpcMainEvent extends Event {
-
- // Docs: http://electronjs.org/docs/api/structures/ipc-main-event
-
- /**
- * The ID of the renderer frame that sent this message
- */
- frameId: number;
- /**
- * A function that will send an IPC message to the renderer frame that sent the
- * original message that you are currently handling. You should use this method to
- * "reply" to the sent message in order to guarantee the reply will go to the
- * correct process and frame.
- */
- reply: Function;
- /**
- * Set this to the value to be returned in a synchronous message
- */
- returnValue: any;
- /**
- * Returns the `webContents` that sent the message
- */
- sender: WebContents;
- }
-
- interface IpcMainInvokeEvent extends Event {
-
- // Docs: http://electronjs.org/docs/api/structures/ipc-main-invoke-event
-
- /**
- * The ID of the renderer frame that sent this message
- */
- frameId: number;
- /**
- * Returns the `webContents` that sent the message
- */
- sender: WebContents;
- }
-
- interface IpcRenderer extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/ipc-renderer
-
- /**
- * Resolves with the response from the main process.
- *
- * Send a message to the main process asynchronously via `channel` and expect an
- * asynchronous result. Arguments will be serialized as JSON internally and hence
- * no functions or prototype chain will be included.
- *
- * The main process should listen for `channel` with `ipcMain.handle()`.
- *
-For example:
- */
- invoke(channel: string, ...args: any[]): Promise;
- /**
- * Listens to `channel`, when a new message arrives `listener` would be called with
- * `listener(event, args...)`.
- */
- on(channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void): this;
- /**
- * Adds a one time `listener` function for the event. This `listener` is invoked
- * only the next time a message is sent to `channel`, after which it is removed.
- */
- once(channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void): this;
- /**
- * Removes all listeners, or those of the specified `channel`.
- */
- removeAllListeners(channel: string): this;
- /**
- * Removes the specified `listener` from the listener array for the specified
- * `channel`.
- */
- removeListener(channel: string, listener: (...args: any[]) => void): this;
- /**
- * Send a message to the main process asynchronously via `channel`, you can also
- * send arbitrary arguments. Arguments will be serialized as JSON internally and
- * hence no functions or prototype chain will be included.
- *
- * The main process handles it by listening for `channel` with the `ipcMain`
- * module.
- */
- send(channel: string, ...args: any[]): void;
- /**
- * The value sent back by the `ipcMain` handler.
- *
- * Send a message to the main process synchronously via `channel`, you can also
- * send arbitrary arguments. Arguments will be serialized in JSON internally and
- * hence no functions or prototype chain will be included.
- *
- * The main process handles it by listening for `channel` with `ipcMain` module,
- * and replies by setting `event.returnValue`.
- *
- * **Note:** Sending a synchronous message will block the whole renderer process,
- * unless you know what you are doing you should never use it.
- */
- sendSync(channel: string, ...args: any[]): any;
- /**
- * Sends a message to a window with `webContentsId` via `channel`.
- */
- sendTo(webContentsId: number, channel: string, ...args: any[]): void;
- /**
- * Like `ipcRenderer.send` but the event will be sent to the `` element in
- * the host page instead of the main process.
- */
- sendToHost(channel: string, ...args: any[]): void;
- }
-
- interface IpcRendererEvent extends Event {
-
- // Docs: http://electronjs.org/docs/api/structures/ipc-renderer-event
-
- /**
- * The `IpcRenderer` instance that emitted the event originally
- */
- sender: IpcRenderer;
- /**
- * The `webContents.id` that sent the message, you can call
- * `event.sender.sendTo(event.senderId, ...)` to reply to the message, see
- * ipcRenderer.sendTo for more information. This only applies to messages sent from
- * a different renderer. Messages sent directly from the main process set
- * `event.senderId` to `0`.
- */
- senderId: number;
- }
-
- interface JumpListCategory {
-
- // Docs: http://electronjs.org/docs/api/structures/jump-list-category
-
- /**
- * Array of `JumpListItem` objects if `type` is `tasks` or `custom`, otherwise it
- * should be omitted.
- */
- items?: JumpListItem[];
- /**
- * Must be set if `type` is `custom`, otherwise it should be omitted.
- */
- name?: string;
- /**
- * One of the following:
- */
- type?: ('tasks' | 'frequent' | 'recent' | 'custom');
- }
-
- interface JumpListItem {
-
- // Docs: http://electronjs.org/docs/api/structures/jump-list-item
-
- /**
- * The command line arguments when `program` is executed. Should only be set if
- * `type` is `task`.
- */
- args?: string;
- /**
- * Description of the task (displayed in a tooltip). Should only be set if `type`
- * is `task`.
- */
- description?: string;
- /**
- * The index of the icon in the resource file. If a resource file contains multiple
- * icons this value can be used to specify the zero-based index of the icon that
- * should be displayed for this task. If a resource file contains only one icon,
- * this property should be set to zero.
- */
- iconIndex?: number;
- /**
- * The absolute path to an icon to be displayed in a Jump List, which can be an
- * arbitrary resource file that contains an icon (e.g. `.ico`, `.exe`, `.dll`). You
- * can usually specify `process.execPath` to show the program icon.
- */
- iconPath?: string;
- /**
- * Path of the file to open, should only be set if `type` is `file`.
- */
- path?: string;
- /**
- * Path of the program to execute, usually you should specify `process.execPath`
- * which opens the current program. Should only be set if `type` is `task`.
- */
- program?: string;
- /**
- * The text to be displayed for the item in the Jump List. Should only be set if
- * `type` is `task`.
- */
- title?: string;
- /**
- * One of the following:
- */
- type?: ('task' | 'separator' | 'file');
- /**
- * The working directory. Default is empty.
- */
- workingDirectory?: string;
- }
-
- interface KeyboardEvent extends Event {
-
- // Docs: http://electronjs.org/docs/api/structures/keyboard-event
-
- /**
- * whether an Alt key was used in an accelerator to trigger the Event
- */
- altKey?: boolean;
- /**
- * whether the Control key was used in an accelerator to trigger the Event
- */
- ctrlKey?: boolean;
- /**
- * whether a meta key was used in an accelerator to trigger the Event
- */
- metaKey?: boolean;
- /**
- * whether a Shift key was used in an accelerator to trigger the Event
- */
- shiftKey?: boolean;
- /**
- * whether an accelerator was used to trigger the event as opposed to another user
- * gesture like mouse click
- */
- triggeredByAccelerator?: boolean;
- }
-
- interface KeyboardInputEvent extends InputEvent {
-
- // Docs: http://electronjs.org/docs/api/structures/keyboard-input-event
-
- /**
- * The character that will be sent as the keyboard event. Should only use the valid
- * key codes in Accelerator.
- */
- keyCode: string;
- /**
- * The type of the event, can be `keyDown`, `keyUp` or `char`.
- */
- type: ('keyDown' | 'keyUp' | 'char');
- }
-
- interface MemoryInfo {
-
- // Docs: http://electronjs.org/docs/api/structures/memory-info
-
- /**
- * The maximum amount of memory that has ever been pinned to actual physical RAM.
- */
- peakWorkingSetSize: number;
- /**
- * The amount of memory not shared by other processes, such as JS heap or HTML
- * content.
- *
- * @platform win32
- */
- privateBytes?: number;
- /**
- * The amount of memory currently pinned to actual physical RAM.
- */
- workingSetSize: number;
- }
-
- interface MemoryUsageDetails {
-
- // Docs: http://electronjs.org/docs/api/structures/memory-usage-details
-
- count: number;
- liveSize: number;
- size: number;
- }
-
- class Menu {
-
- // Docs: http://electronjs.org/docs/api/menu
-
- /**
- * Emitted when a popup is closed either manually or with `menu.closePopup()`.
- */
- on(event: 'menu-will-close', listener: (event: Event) => void): this;
- once(event: 'menu-will-close', listener: (event: Event) => void): this;
- addListener(event: 'menu-will-close', listener: (event: Event) => void): this;
- removeListener(event: 'menu-will-close', listener: (event: Event) => void): this;
- /**
- * Emitted when `menu.popup()` is called.
- */
- on(event: 'menu-will-show', listener: (event: Event) => void): this;
- once(event: 'menu-will-show', listener: (event: Event) => void): this;
- addListener(event: 'menu-will-show', listener: (event: Event) => void): this;
- removeListener(event: 'menu-will-show', listener: (event: Event) => void): this;
- /**
- * Menu
- */
- constructor();
- /**
- * Generally, the `template` is an array of `options` for constructing a MenuItem.
- * The usage can be referenced above.
- *
- * You can also attach other fields to the element of the `template` and they will
- * become properties of the constructed menu items.
- */
- static buildFromTemplate(template: Array<(MenuItemConstructorOptions) | (MenuItem)>): Menu;
- /**
- * The application menu, if set, or `null`, if not set.
- *
- * **Note:** The returned `Menu` instance doesn't support dynamic addition or
- * removal of menu items. Instance properties can still be dynamically modified.
- */
- static getApplicationMenu(): (Menu) | (null);
- /**
- * Sends the `action` to the first responder of application. This is used for
- * emulating default macOS menu behaviors. Usually you would use the `role`
- * property of a `MenuItem`.
- *
- * See the macOS Cocoa Event Handling Guide for more information on macOS' native
- * actions.
- *
- * @platform darwin
- */
- static sendActionToFirstResponder(action: string): void;
- /**
- * Sets `menu` as the application menu on macOS. On Windows and Linux, the `menu`
- * will be set as each window's top menu.
- *
- * Also on Windows and Linux, you can use a `&` in the top-level item name to
- * indicate which letter should get a generated accelerator. For example, using
- * `&File` for the file menu would result in a generated `Alt-F` accelerator that
- * opens the associated menu. The indicated character in the button label gets an
- * underline. The `&` character is not displayed on the button label.
- *
- * Passing `null` will suppress the default menu. On Windows and Linux, this has
- * the additional effect of removing the menu bar from the window.
- *
- * **Note:** The default menu will be created automatically if the app does not set
- * one. It contains standard items such as `File`, `Edit`, `View`, `Window` and
- * `Help`.
- */
- static setApplicationMenu(menu: (Menu) | (null)): void;
- /**
- * Appends the `menuItem` to the menu.
- */
- append(menuItem: MenuItem): void;
- /**
- * Closes the context menu in the `browserWindow`.
- */
- closePopup(browserWindow?: BrowserWindow): void;
- /**
- * the item with the specified `id`
- */
- getMenuItemById(id: string): MenuItem;
- /**
- * Inserts the `menuItem` to the `pos` position of the menu.
- */
- insert(pos: number, menuItem: MenuItem): void;
- /**
- * Pops up this menu as a context menu in the `BrowserWindow`.
- */
- popup(options?: PopupOptions): void;
- items: MenuItem[];
- }
-
- class MenuItem {
-
- // Docs: http://electronjs.org/docs/api/menu-item
-
- /**
- * MenuItem
- */
- constructor(options: MenuItemConstructorOptions);
- accelerator?: Accelerator;
- checked: boolean;
- click: Function;
- commandId: number;
- enabled: boolean;
- icon?: (NativeImage) | (string);
- id: string;
- label: string;
- menu: Menu;
- registerAccelerator: boolean;
- role?: ('undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'pasteAndMatchStyle' | 'delete' | 'selectAll' | 'reload' | 'forceReload' | 'toggleDevTools' | 'resetZoom' | 'zoomIn' | 'zoomOut' | 'togglefullscreen' | 'window' | 'minimize' | 'close' | 'help' | 'about' | 'services' | 'hide' | 'hideOthers' | 'unhide' | 'quit' | 'startSpeaking' | 'stopSpeaking' | 'close' | 'minimize' | 'zoom' | 'front' | 'appMenu' | 'fileMenu' | 'editMenu' | 'viewMenu' | 'recentDocuments' | 'toggleTabBar' | 'selectNextTab' | 'selectPreviousTab' | 'mergeAllWindows' | 'clearRecentDocuments' | 'moveTabToNewWindow' | 'windowMenu');
- sublabel: string;
- submenu?: Menu;
- toolTip: string;
- type: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
- visible: boolean;
- }
-
- interface MimeTypedBuffer {
-
- // Docs: http://electronjs.org/docs/api/structures/mime-typed-buffer
-
- /**
- * The actual Buffer content.
- */
- data: Buffer;
- /**
- * The mimeType of the Buffer that you are sending.
- */
- mimeType: string;
- }
-
- interface MouseInputEvent extends InputEvent {
-
- // Docs: http://electronjs.org/docs/api/structures/mouse-input-event
-
- /**
- * The button pressed, can be `left`, `middle`, `right`.
- */
- button?: ('left' | 'middle' | 'right');
- clickCount?: number;
- globalX?: number;
- globalY?: number;
- movementX?: number;
- movementY?: number;
- /**
- * The type of the event, can be `mouseDown`, `mouseUp`, `mouseEnter`,
- * `mouseLeave`, `contextMenu`, `mouseWheel` or `mouseMove`.
- */
- type: ('mouseDown' | 'mouseUp' | 'mouseEnter' | 'mouseLeave' | 'contextMenu' | 'mouseWheel' | 'mouseMove');
- x: number;
- y: number;
- }
-
- interface MouseWheelInputEvent extends MouseInputEvent {
-
- // Docs: http://electronjs.org/docs/api/structures/mouse-wheel-input-event
-
- accelerationRatioX?: number;
- accelerationRatioY?: number;
- canScroll?: boolean;
- deltaX?: number;
- deltaY?: number;
- hasPreciseScrollingDeltas?: boolean;
- /**
- * The type of the event, can be `mouseWheel`.
- */
- type: ('mouseWheel');
- wheelTicksX?: number;
- wheelTicksY?: number;
- }
-
- class NativeImage {
-
- // Docs: http://electronjs.org/docs/api/native-image
-
- /**
- * Creates an empty `NativeImage` instance.
- */
- static createEmpty(): NativeImage;
- /**
- * Creates a new `NativeImage` instance from `buffer` that contains the raw bitmap
- * pixel data returned by `toBitmap()`. The specific format is platform-dependent.
- */
- static createFromBitmap(buffer: Buffer, options: CreateFromBitmapOptions): NativeImage;
- /**
- * Creates a new `NativeImage` instance from `buffer`. Tries to decode as PNG or
- * JPEG first.
- */
- static createFromBuffer(buffer: Buffer, options?: CreateFromBufferOptions): NativeImage;
- /**
- * Creates a new `NativeImage` instance from `dataURL`.
- */
- static createFromDataURL(dataURL: string): NativeImage;
- /**
- * Creates a new `NativeImage` instance from the NSImage that maps to the given
- * image name. See `System Icons` for a list of possible values.
- *
- * The `hslShift` is applied to the image with the following rules
- *
- * * `hsl_shift[0]` (hue): The absolute hue value for the image - 0 and 1 map to 0
- * and 360 on the hue color wheel (red).
- * * `hsl_shift[1]` (saturation): A saturation shift for the image, with the
- * following key values: 0 = remove all color. 0.5 = leave unchanged. 1 = fully
- * saturate the image.
- * * `hsl_shift[2]` (lightness): A lightness shift for the image, with the
- * following key values: 0 = remove all lightness (make all pixels black). 0.5 =
- * leave unchanged. 1 = full lightness (make all pixels white).
- *
- * This means that `[-1, 0, 1]` will make the image completely white and `[-1, 1,
- * 0]` will make the image completely black.
- *
- * In some cases, the `NSImageName` doesn't match its string representation; one
- * example of this is `NSFolderImageName`, whose string representation would
- * actually be `NSFolder`. Therefore, you'll need to determine the correct string
- * representation for your image before passing it in. This can be done with the
- * following:
- *
- * `echo -e '#import \nint main() { NSLog(@"%@", SYSTEM_IMAGE_NAME);
- * }' | clang -otest -x objective-c -framework Cocoa - && ./test`
- *
-where `SYSTEM_IMAGE_NAME` should be replaced with any value from this list.
- *
- * @platform darwin
- */
- static createFromNamedImage(imageName: string, hslShift?: number[]): NativeImage;
- /**
- * Creates a new `NativeImage` instance from a file located at `path`. This method
- * returns an empty image if the `path` does not exist, cannot be read, or is not a
- * valid image.
- */
- static createFromPath(path: string): NativeImage;
- /**
- * A `Boolean` property that determines whether the image is considered a template
- * image.
-
-Please note that this property only has an effect on macOS.
- *
- * @platform darwin
- */
- static isMacTemplateImage: boolean;
- /**
- * Add an image representation for a specific scale factor. This can be used to
- * explicitly add different scale factor representations to an image. This can be
- * called on empty images.
- */
- addRepresentation(options: AddRepresentationOptions): void;
- /**
- * The cropped image.
- */
- crop(rect: Rectangle): NativeImage;
- /**
- * The image's aspect ratio.
- */
- getAspectRatio(): number;
- /**
- * A Buffer that contains the image's raw bitmap pixel data.
- *
- * The difference between `getBitmap()` and `toBitmap()` is, `getBitmap()` does not
- * copy the bitmap data, so you have to use the returned Buffer immediately in
- * current event loop tick, otherwise the data might be changed or destroyed.
- */
- getBitmap(options?: BitmapOptions): Buffer;
- /**
- * A Buffer that stores C pointer to underlying native handle of the image. On
- * macOS, a pointer to `NSImage` instance would be returned.
- *
- * Notice that the returned pointer is a weak pointer to the underlying native
- * image instead of a copy, so you _must_ ensure that the associated `nativeImage`
- * instance is kept around.
- *
- * @platform darwin
- */
- getNativeHandle(): Buffer;
- getSize(): Size;
- /**
- * Whether the image is empty.
- */
- isEmpty(): boolean;
- /**
- * Whether the image is a template image.
-
-**Deprecated**
- */
- isTemplateImage(): boolean;
- /**
- * The resized image.
- *
- * If only the `height` or the `width` are specified then the current aspect ratio
- * will be preserved in the resized image.
- */
- resize(options: ResizeOptions): NativeImage;
- /**
- * Marks the image as a template image.
-
-**Deprecated**
- */
- setTemplateImage(option: boolean): void;
- /**
- * A Buffer that contains a copy of the image's raw bitmap pixel data.
- */
- toBitmap(options?: ToBitmapOptions): Buffer;
- /**
- * The data URL of the image.
- */
- toDataURL(options?: ToDataURLOptions): string;
- /**
- * A Buffer that contains the image's `JPEG` encoded data.
- */
- toJPEG(quality: number): Buffer;
- /**
- * A Buffer that contains the image's `PNG` encoded data.
- */
- toPNG(options?: ToPNGOptions): Buffer;
- }
-
- interface NativeTheme extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/native-theme
-
- /**
- * Emitted when something in the underlying NativeTheme has changed. This normally
- * means that either the value of `shouldUseDarkColors`,
- * `shouldUseHighContrastColors` or `shouldUseInvertedColorScheme` has changed. You
- * will have to check them to determine which one has changed.
- */
- on(event: 'updated', listener: Function): this;
- once(event: 'updated', listener: Function): this;
- addListener(event: 'updated', listener: Function): this;
- removeListener(event: 'updated', listener: Function): this;
- /**
- * A `Boolean` for if the OS / Chromium currently has a dark mode enabled or is
- * being instructed to show a dark-style UI. If you want to modify this value you
- * should use `themeSource` below.
- *
- */
- readonly shouldUseDarkColors: boolean;
- /**
- * A `Boolean` for if the OS / Chromium currently has high-contrast mode enabled or
- * is being instructed to show a high-constrast UI.
- *
- * @platform darwin,win32
- */
- readonly shouldUseHighContrastColors: boolean;
- /**
- * A `Boolean` for if the OS / Chromium currently has an inverted color scheme or
- * is being instructed to use an inverted color scheme.
- *
- * @platform darwin,win32
- */
- readonly shouldUseInvertedColorScheme: boolean;
- /**
- * A `String` property that can be `system`, `light` or `dark`. It is used to
- * override and supercede the value that Chromium has chosen to use internally.
- *
- * Setting this property to `system` will remove the override and everything will
- * be reset to the OS default. By default `themeSource` is `system`.
- *
- * Settings this property to `dark` will have the following effects:
- *
- * * `nativeTheme.shouldUseDarkColors` will be `true` when accessed
- * * Any UI Electron renders on Linux and Windows including context menus,
- * devtools, etc. will use the dark UI.
- * * Any UI the OS renders on macOS including menus, window frames, etc. will use
- * the dark UI.
- * * The `prefers-color-scheme` CSS query will match `dark` mode.
- * * The `updated` event will be emitted
- *
- * Settings this property to `light` will have the following effects:
- *
- * * `nativeTheme.shouldUseDarkColors` will be `false` when accessed
- * * Any UI Electron renders on Linux and Windows including context menus,
- * devtools, etc. will use the light UI.
- * * Any UI the OS renders on macOS including menus, window frames, etc. will use
- * the light UI.
- * * The `prefers-color-scheme` CSS query will match `light` mode.
- * * The `updated` event will be emitted
- *
- * The usage of this property should align with a classic "dark mode" state machine
- * in your application where the user has three options.
- *
- * * `Follow OS` --> `themeSource = 'system'`
- * * `Dark Mode` --> `themeSource = 'dark'`
- * * `Light Mode` --> `themeSource = 'light'`
- *
- * Your application should then always use `shouldUseDarkColors` to determine what
- * CSS to apply.
- */
- themeSource: ('system' | 'light' | 'dark');
- }
-
- interface Net {
-
- // Docs: http://electronjs.org/docs/api/net
-
- /**
- * Creates a `ClientRequest` instance using the provided `options` which are
- * directly forwarded to the `ClientRequest` constructor. The `net.request` method
- * would be used to issue both secure and insecure HTTP requests according to the
- * specified protocol scheme in the `options` object.
- */
- request(options: (ClientRequestConstructorOptions) | (string)): ClientRequest;
- }
-
- interface NetLog {
-
- // Docs: http://electronjs.org/docs/api/net-log
-
- /**
- * resolves when the net log has begun recording.
- *
-Starts recording network events to `path`.
- */
- startLogging(path: string, options?: StartLoggingOptions): Promise;
- /**
- * resolves with a file path to which network logs were recorded.
- *
- * Stops recording network events. If not called, net logging will automatically
- * end when app quits.
- */
- stopLogging(): Promise;
- /**
- * A `Boolean` property that indicates whether network logs are recorded.
- *
- */
- readonly currentlyLogging: boolean;
- /**
- * A `String` property that returns the path to the current log file.
- *
- * @deprecated
- */
- readonly currentlyLoggingPath: string;
- }
-
- class Notification extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/notification
-
- on(event: 'action', listener: (event: Event,
- /**
- * The index of the action that was activated.
- */
- index: number) => void): this;
- once(event: 'action', listener: (event: Event,
- /**
- * The index of the action that was activated.
- */
- index: number) => void): this;
- addListener(event: 'action', listener: (event: Event,
- /**
- * The index of the action that was activated.
- */
- index: number) => void): this;
- removeListener(event: 'action', listener: (event: Event,
- /**
- * The index of the action that was activated.
- */
- index: number) => void): this;
- /**
- * Emitted when the notification is clicked by the user.
- */
- on(event: 'click', listener: (event: Event) => void): this;
- once(event: 'click', listener: (event: Event) => void): this;
- addListener(event: 'click', listener: (event: Event) => void): this;
- removeListener(event: 'click', listener: (event: Event) => void): this;
- /**
- * Emitted when the notification is closed by manual intervention from the user.
- *
- * This event is not guaranteed to be emitted in all cases where the notification
- * is closed.
- */
- on(event: 'close', listener: (event: Event) => void): this;
- once(event: 'close', listener: (event: Event) => void): this;
- addListener(event: 'close', listener: (event: Event) => void): this;
- removeListener(event: 'close', listener: (event: Event) => void): this;
- /**
- * Emitted when the user clicks the "Reply" button on a notification with
- * `hasReply: true`.
- *
- * @platform darwin
- */
- on(event: 'reply', listener: (event: Event,
- /**
- * The string the user entered into the inline reply field.
- */
- reply: string) => void): this;
- once(event: 'reply', listener: (event: Event,
- /**
- * The string the user entered into the inline reply field.
- */
- reply: string) => void): this;
- addListener(event: 'reply', listener: (event: Event,
- /**
- * The string the user entered into the inline reply field.
- */
- reply: string) => void): this;
- removeListener(event: 'reply', listener: (event: Event,
- /**
- * The string the user entered into the inline reply field.
- */
- reply: string) => void): this;
- /**
- * Emitted when the notification is shown to the user, note this could be fired
- * multiple times as a notification can be shown multiple times through the
- * `show()` method.
- */
- on(event: 'show', listener: (event: Event) => void): this;
- once(event: 'show', listener: (event: Event) => void): this;
- addListener(event: 'show', listener: (event: Event) => void): this;
- removeListener(event: 'show', listener: (event: Event) => void): this;
- /**
- * Notification
- */
- constructor(options?: NotificationConstructorOptions);
- /**
- * Whether or not desktop notifications are supported on the current system
- */
- static isSupported(): boolean;
- /**
- * Dismisses the notification.
- */
- close(): void;
- /**
- * Immediately shows the notification to the user, please note this means unlike
- * the HTML5 Notification implementation, instantiating a `new Notification` does
- * not immediately show it to the user, you need to call this method before the OS
- * will display it.
- *
- * If the notification has been shown before, this method will dismiss the
- * previously shown notification and create a new one with identical properties.
- */
- show(): void;
- actions: NotificationAction[];
- body: string;
- closeButtonText: string;
- hasReply: boolean;
- replyPlaceholder: string;
- silent: boolean;
- sound: string;
- subtitle: string;
- title: string;
- }
-
- interface NotificationAction {
-
- // Docs: http://electronjs.org/docs/api/structures/notification-action
-
- /**
- * The label for the given action.
- */
- text?: string;
- /**
- * The type of action, can be `button`.
- */
- type: ('button');
- }
-
- interface Point {
-
- // Docs: http://electronjs.org/docs/api/structures/point
-
- x: number;
- y: number;
- }
-
- interface PowerMonitor extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/power-monitor
-
- /**
- * Emitted when the system is about to lock the screen.
- *
- * @platform darwin,win32
- */
- on(event: 'lock-screen', listener: Function): this;
- once(event: 'lock-screen', listener: Function): this;
- addListener(event: 'lock-screen', listener: Function): this;
- removeListener(event: 'lock-screen', listener: Function): this;
- /**
- * Emitted when the system changes to AC power.
- *
- * @platform win32
- */
- on(event: 'on-ac', listener: Function): this;
- once(event: 'on-ac', listener: Function): this;
- addListener(event: 'on-ac', listener: Function): this;
- removeListener(event: 'on-ac', listener: Function): this;
- /**
- * Emitted when system changes to battery power.
- *
- * @platform win32
- */
- on(event: 'on-battery', listener: Function): this;
- once(event: 'on-battery', listener: Function): this;
- addListener(event: 'on-battery', listener: Function): this;
- removeListener(event: 'on-battery', listener: Function): this;
- /**
- * Emitted when system is resuming.
- */
- on(event: 'resume', listener: Function): this;
- once(event: 'resume', listener: Function): this;
- addListener(event: 'resume', listener: Function): this;
- removeListener(event: 'resume', listener: Function): this;
- /**
- * Emitted when the system is about to reboot or shut down. If the event handler
- * invokes `e.preventDefault()`, Electron will attempt to delay system shutdown in
- * order for the app to exit cleanly. If `e.preventDefault()` is called, the app
- * should exit as soon as possible by calling something like `app.quit()`.
- *
- * @platform linux,darwin
- */
- on(event: 'shutdown', listener: Function): this;
- once(event: 'shutdown', listener: Function): this;
- addListener(event: 'shutdown', listener: Function): this;
- removeListener(event: 'shutdown', listener: Function): this;
- /**
- * Emitted when the system is suspending.
- */
- on(event: 'suspend', listener: Function): this;
- once(event: 'suspend', listener: Function): this;
- addListener(event: 'suspend', listener: Function): this;
- removeListener(event: 'suspend', listener: Function): this;
- /**
- * Emitted as soon as the systems screen is unlocked.
- *
- * @platform darwin,win32
- */
- on(event: 'unlock-screen', listener: Function): this;
- once(event: 'unlock-screen', listener: Function): this;
- addListener(event: 'unlock-screen', listener: Function): this;
- removeListener(event: 'unlock-screen', listener: Function): this;
- /**
- * The system's current state. Can be `active`, `idle`, `locked` or `unknown`.
- *
- * Calculate the system idle state. `idleThreshold` is the amount of time (in
- * seconds) before considered idle. `locked` is available on supported systems
- * only.
- */
- getSystemIdleState(idleThreshold: number): ('active' | 'idle' | 'locked' | 'unknown');
- /**
- * Idle time in seconds
-
-Calculate system idle time in seconds.
- */
- getSystemIdleTime(): number;
- }
-
- interface PowerSaveBlocker {
-
- // Docs: http://electronjs.org/docs/api/power-save-blocker
-
- /**
- * Whether the corresponding `powerSaveBlocker` has started.
- */
- isStarted(id: number): boolean;
- /**
- * The blocker ID that is assigned to this power blocker.
- *
- * Starts preventing the system from entering lower-power mode. Returns an integer
- * identifying the power save blocker.
- *
- * **Note:** `prevent-display-sleep` has higher precedence over
- * `prevent-app-suspension`. Only the highest precedence type takes effect. In
- * other words, `prevent-display-sleep` always takes precedence over
- * `prevent-app-suspension`.
- *
- * For example, an API calling A requests for `prevent-app-suspension`, and another
- * calling B requests for `prevent-display-sleep`. `prevent-display-sleep` will be
- * used until B stops its request. After that, `prevent-app-suspension` is used.
- */
- start(type: 'prevent-app-suspension' | 'prevent-display-sleep'): number;
- /**
- * Stops the specified power save blocker.
- */
- stop(id: number): void;
- }
-
- interface PrinterInfo {
-
- // Docs: http://electronjs.org/docs/api/structures/printer-info
-
- description: string;
- isDefault: boolean;
- name: string;
- status: number;
- }
-
- interface ProcessMemoryInfo {
-
- // Docs: http://electronjs.org/docs/api/structures/process-memory-info
-
- /**
- * The amount of memory not shared by other processes, such as JS heap or HTML
- * content in Kilobytes.
- */
- private: number;
- /**
- * The amount of memory currently pinned to actual physical RAM in Kilobytes.
- *
- * @platform linux,win32
- */
- residentSet: number;
- /**
- * The amount of memory shared between processes, typically memory consumed by the
- * Electron code itself in Kilobytes.
- */
- shared: number;
- }
-
- interface ProcessMetric {
-
- // Docs: http://electronjs.org/docs/api/structures/process-metric
-
- /**
- * CPU usage of the process.
- */
- cpu: CPUUsage;
- /**
- * Creation time for this process. The time is represented as number of
- * milliseconds since epoch. Since the `pid` can be reused after a process dies, it
- * is useful to use both the `pid` and the `creationTime` to uniquely identify a
- * process.
- */
- creationTime: number;
- /**
- * One of the following values:
- *
- * @platform win32
- */
- integrityLevel?: ('untrusted' | 'low' | 'medium' | 'high' | 'unknown');
- /**
- * Memory information for the process.
- */
- memory: MemoryInfo;
- /**
- * Process id of the process.
- */
- pid: number;
- /**
- * Whether the process is sandboxed on OS level.
- *
- * @platform darwin,win32
- */
- sandboxed?: boolean;
- /**
- * Process type. One of the following values:
- */
- type: ('Browser' | 'Tab' | 'Utility' | 'Zygote' | 'Sandbox helper' | 'GPU' | 'Pepper Plugin' | 'Pepper Plugin Broker' | 'Unknown');
- }
-
- interface Product {
-
- // Docs: http://electronjs.org/docs/api/structures/product
-
- /**
- * The total size of the content, in bytes.
- */
- contentLengths: number[];
- /**
- * A string that identifies the version of the content.
- */
- contentVersion: string;
- /**
- * The locale formatted price of the product.
- */
- formattedPrice: string;
- /**
- * A Boolean value that indicates whether the App Store has downloadable content
- * for this product. `true` if at least one file has been associated with the
- * product.
- */
- isDownloadable: boolean;
- /**
- * A description of the product.
- */
- localizedDescription: string;
- /**
- * The name of the product.
- */
- localizedTitle: string;
- /**
- * The cost of the product in the local currency.
- */
- price: number;
- /**
- * The string that identifies the product to the Apple App Store.
- */
- productIdentifier: string;
- }
-
- interface Protocol {
-
- // Docs: http://electronjs.org/docs/api/protocol
-
- /**
- * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
- * which sends a `Buffer` as a response.
- */
- interceptBufferProtocol(scheme: string, handler: (request: HandlerRequest, callback: (buffer?: Buffer) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
- * which sends a file as a response.
- */
- interceptFileProtocol(scheme: string, handler: (request: HandlerRequest, callback: (filePath: string) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
- * which sends a new HTTP request as a response.
- */
- interceptHttpProtocol(scheme: string, handler: (request: HandlerRequest, callback: (redirectRequest: RedirectRequest) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Same as `protocol.registerStreamProtocol`, except that it replaces an existing
- * protocol handler.
- */
- interceptStreamProtocol(scheme: string, handler: (request: HandlerRequest, callback: (stream?: (NodeJS.ReadableStream) | (StreamProtocolResponse)) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
- * which sends a `String` as a response.
- */
- interceptStringProtocol(scheme: string, handler: (request: HandlerRequest, callback: (data?: (string) | (StringProtocolResponse)) => void) => void, completion?: (error: Error) => void): void;
- /**
- * fulfilled with a boolean that indicates whether there is already a handler for
- * `scheme`.
- */
- isProtocolHandled(scheme: string): Promise;
- /**
- * Registers a protocol of `scheme` that will send a `Buffer` as a response.
- *
- * The usage is the same with `registerFileProtocol`, except that the `callback`
- * should be called with either a `Buffer` object or an object that has the `data`,
- * `mimeType`, and `charset` properties.
-
-Example:
- */
- registerBufferProtocol(scheme: string, handler: (request: HandlerRequest, callback: (buffer?: (Buffer) | (MimeTypedBuffer)) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Registers a protocol of `scheme` that will send the file as a response. The
- * `handler` will be called with `handler(request, callback)` when a `request` is
- * going to be created with `scheme`. `completion` will be called with
- * `completion(null)` when `scheme` is successfully registered or
- * `completion(error)` when failed.
- *
- * To handle the `request`, the `callback` should be called with either the file's
- * path or an object that has a `path` property, e.g. `callback(filePath)` or
- * `callback({ path: filePath })`. The object may also have a `headers` property
- * which gives a map of headers to values for the response headers, e.g.
- * `callback({ path: filePath, headers: {"Content-Security-Policy": "default-src
- * 'none'"]})`.
- *
- * When `callback` is called with nothing, a number, or an object that has an
- * `error` property, the `request` will fail with the `error` number you specified.
- * For the available error numbers you can use, please see the net error list.
- *
- * By default the `scheme` is treated like `http:`, which is parsed differently
- * than protocols that follow the "generic URI syntax" like `file:`.
- */
- registerFileProtocol(scheme: string, handler: (request: HandlerRequest, callback: (filePath?: (string) | (FilePathWithHeaders)) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Registers a protocol of `scheme` that will send an HTTP request as a response.
- *
- * The usage is the same with `registerFileProtocol`, except that the `callback`
- * should be called with a `redirectRequest` object that has the `url`, `method`,
- * `referrer`, `uploadData` and `session` properties.
- *
- * By default the HTTP request will reuse the current session. If you want the
- * request to have a different session you should set `session` to `null`.
- *
-For POST requests the `uploadData` object must be provided.
- */
- registerHttpProtocol(scheme: string, handler: (request: HandlerRequest, callback: (redirectRequest: CallbackRedirectRequest) => void) => void, completion?: (error: Error) => void): void;
- /**
- * **Note:** This method can only be used before the `ready` event of the `app`
- * module gets emitted and can be called only once.
- *
- * Registers the `scheme` as standard, secure, bypasses content security policy for
- * resources, allows registering ServiceWorker and supports fetch API.
- *
- * Specify a privilege with the value of `true` to enable the capability. An
- * example of registering a privileged scheme, with bypassing Content Security
- * Policy:
- *
- * A standard scheme adheres to what RFC 3986 calls generic URI syntax. For example
- * `http` and `https` are standard schemes, while `file` is not.
- *
- * Registering a scheme as standard, will allow relative and absolute resources to
- * be resolved correctly when served. Otherwise the scheme will behave like the
- * `file` protocol, but without the ability to resolve relative URLs.
- *
- * For example when you load following page with custom protocol without
- * registering it as standard scheme, the image will not be loaded because
- * non-standard schemes can not recognize relative URLs:
- *
- * Registering a scheme as standard will allow access to files through the
- * FileSystem API. Otherwise the renderer will throw a security error for the
- * scheme.
- *
- * By default web storage apis (localStorage, sessionStorage, webSQL, indexedDB,
- * cookies) are disabled for non standard schemes. So in general if you want to
- * register a custom protocol to replace the `http` protocol, you have to register
- * it as a standard scheme.
- *
- * `protocol.registerSchemesAsPrivileged` can be used to replicate the
- * functionality of the previous `protocol.registerStandardSchemes`,
- * `webFrame.registerURLSchemeAs*` and `protocol.registerServiceWorkerSchemes`
- * functions that existed prior to Electron 5.0.0, for example:
- *
-**before (<= v4.x)**
-
-**after (>= v5.x)**
- */
- registerSchemesAsPrivileged(customSchemes: CustomScheme[]): void;
- /**
- * Registers a protocol of `scheme` that will send a `Readable` as a response.
- *
- * The usage is similar to the other `register{Any}Protocol`, except that the
- * `callback` should be called with either a `Readable` object or an object that
- * has the `data`, `statusCode`, and `headers` properties.
- *
- * Example:
- *
- * It is possible to pass any object that implements the readable stream API (emits
- * `data`/`end`/`error` events). For example, here's how a file could be returned:
- */
- registerStreamProtocol(scheme: string, handler: (request: HandlerRequest, callback: (stream?: (NodeJS.ReadableStream) | (StreamProtocolResponse)) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Registers a protocol of `scheme` that will send a `String` as a response.
- *
- * The usage is the same with `registerFileProtocol`, except that the `callback`
- * should be called with either a `String` or an object that has the `data`,
- * `mimeType`, and `charset` properties.
- */
- registerStringProtocol(scheme: string, handler: (request: HandlerRequest, callback: (data?: (string) | (StringProtocolResponse)) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Remove the interceptor installed for `scheme` and restore its original handler.
- */
- uninterceptProtocol(scheme: string, completion?: (error: Error) => void): void;
- /**
- * Unregisters the custom protocol of `scheme`.
- */
- unregisterProtocol(scheme: string, completion?: (error: Error) => void): void;
- }
-
- interface ProtocolRequest {
-
- // Docs: http://electronjs.org/docs/api/structures/protocol-request
-
- method: string;
- referrer: string;
- uploadData?: UploadData[];
- url: string;
- }
-
- interface ProtocolResponse {
-
- // Docs: http://electronjs.org/docs/api/structures/protocol-response
-
- /**
- * The charset of response body, default is `"utf-8"`.
- */
- charset?: string;
- /**
- * The response body. When returning stream as response, this is a Node.js readable
- * stream representing the response body. When returning `Buffer` as response, this
- * is a `Buffer`. When returning `String` as response, this is a `String`. This is
- * ignored for other types of responses.
- */
- data?: (Buffer) | (string) | (NodeJS.ReadableStream);
- /**
- * When assigned, the `request` will fail with the `error` number . For the
- * available error numbers you can use, please see the net error list.
- */
- error?: number;
- /**
- * An object containing the response headers. The keys must be String, and values
- * must be either String or Array of String.
- */
- headers?: Record;
- /**
- * The HTTP `method`. This is only used for file and URL responses.
- */
- method?: string;
- /**
- * The MIME type of response body, default is `"text/html"`. Setting `mimeType`
- * would implicitly set the `content-type` header in response, but if
- * `content-type` is already set in `headers`, the `mimeType` would be ignored.
- */
- mimeType?: string;
- /**
- * Path to the file which would be sent as response body. This is only used for
- * file responses.
- */
- path?: string;
- /**
- * The `referrer` URL. This is only used for file and URL responses.
- */
- referrer?: string;
- /**
- * The session used for requesting URL, by default the HTTP request will reuse the
- * current session. Setting `session` to `null` would use a random independent
- * session. This is only used for URL responses.
- */
- session?: Session;
- /**
- * The HTTP response code, default is 200.
- */
- statusCode?: number;
- /**
- * The data used as upload data. This is only used for URL responses when `method`
- * is `"POST"`.
- */
- uploadData?: ProtocolResponseUploadData;
- /**
- * Download the `url` and pipe the result as response body. This is only used for
- * URL responses.
- */
- url?: string;
- }
-
- interface ProtocolResponseUploadData {
-
- // Docs: http://electronjs.org/docs/api/structures/protocol-response-upload-data
-
- /**
- * MIME type of the content.
- */
- contentType: string;
- /**
- * Content to be sent.
- */
- data: string;
- }
-
- interface Rectangle {
-
- // Docs: http://electronjs.org/docs/api/structures/rectangle
-
- /**
- * The height of the rectangle (must be an integer).
- */
- height: number;
- /**
- * The width of the rectangle (must be an integer).
- */
- width: number;
- /**
- * The x coordinate of the origin of the rectangle (must be an integer).
- */
- x: number;
- /**
- * The y coordinate of the origin of the rectangle (must be an integer).
- */
- y: number;
- }
-
- interface Referrer {
-
- // Docs: http://electronjs.org/docs/api/structures/referrer
-
- /**
- * Can be `default`, `unsafe-url`, `no-referrer-when-downgrade`, `no-referrer`,
- * `origin`, `strict-origin-when-cross-origin`, `same-origin` or `strict-origin`.
- * See the Referrer-Policy spec for more details on the meaning of these values.
- */
- policy: ('default' | 'unsafe-url' | 'no-referrer-when-downgrade' | 'no-referrer' | 'origin' | 'strict-origin-when-cross-origin' | 'same-origin' | 'strict-origin');
- /**
- * HTTP Referrer URL.
- */
- url: string;
- }
-
- interface Remote extends MainInterface {
-
- // Docs: http://electronjs.org/docs/api/remote
-
- /**
- * The web contents of this web page.
- */
- getCurrentWebContents(): WebContents;
- /**
- * The window to which this web page belongs.
- *
- * **Note:** Do not use `removeAllListeners` on `BrowserWindow`. Use of this can
- * remove all `blur` listeners, disable click events on touch bar buttons, and
- * other unintended consequences.
- */
- getCurrentWindow(): BrowserWindow;
- /**
- * The global variable of `name` (e.g. `global[name]`) in the main process.
- */
- getGlobal(name: string): any;
- /**
- * The object returned by `require(module)` in the main process. Modules specified
- * by their relative path will resolve relative to the entrypoint of the main
- * process.
-
-e.g.
- */
- require(module: string): any;
- /**
- * A `NodeJS.Process` object. The `process` object in the main process. This is
- * the same as `remote.getGlobal('process')` but is cached.
- *
- */
- readonly process: NodeJS.Process;
- }
-
- interface RemoveClientCertificate {
-
- // Docs: http://electronjs.org/docs/api/structures/remove-client-certificate
-
- /**
- * Origin of the server whose associated client certificate must be removed from
- * the cache.
- */
- origin: string;
- /**
- * `clientCertificate`.
- */
- type: string;
- }
-
- interface RemovePassword {
-
- // Docs: http://electronjs.org/docs/api/structures/remove-password
-
- /**
- * When provided, the authentication info related to the origin will only be
- * removed otherwise the entire cache will be cleared.
- */
- origin?: string;
- /**
- * Credentials of the authentication. Must be provided if removing by `origin`.
- */
- password?: string;
- /**
- * Realm of the authentication. Must be provided if removing by `origin`.
- */
- realm?: string;
- /**
- * Scheme of the authentication. Can be `basic`, `digest`, `ntlm`, `negotiate`.
- * Must be provided if removing by `origin`.
- */
- scheme?: ('basic' | 'digest' | 'ntlm' | 'negotiate');
- /**
- * `password`.
- */
- type: string;
- /**
- * Credentials of the authentication. Must be provided if removing by `origin`.
- */
- username?: string;
- }
-
- interface Screen extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/screen
-
- /**
- * Emitted when `newDisplay` has been added.
- */
- on(event: 'display-added', listener: (event: Event,
- newDisplay: Display) => void): this;
- once(event: 'display-added', listener: (event: Event,
- newDisplay: Display) => void): this;
- addListener(event: 'display-added', listener: (event: Event,
- newDisplay: Display) => void): this;
- removeListener(event: 'display-added', listener: (event: Event,
- newDisplay: Display) => void): this;
- /**
- * Emitted when one or more metrics change in a `display`. The `changedMetrics` is
- * an array of strings that describe the changes. Possible changes are `bounds`,
- * `workArea`, `scaleFactor` and `rotation`.
- */
- on(event: 'display-metrics-changed', listener: (event: Event,
- display: Display,
- changedMetrics: string[]) => void): this;
- once(event: 'display-metrics-changed', listener: (event: Event,
- display: Display,
- changedMetrics: string[]) => void): this;
- addListener(event: 'display-metrics-changed', listener: (event: Event,
- display: Display,
- changedMetrics: string[]) => void): this;
- removeListener(event: 'display-metrics-changed', listener: (event: Event,
- display: Display,
- changedMetrics: string[]) => void): this;
- /**
- * Emitted when `oldDisplay` has been removed.
- */
- on(event: 'display-removed', listener: (event: Event,
- oldDisplay: Display) => void): this;
- once(event: 'display-removed', listener: (event: Event,
- oldDisplay: Display) => void): this;
- addListener(event: 'display-removed', listener: (event: Event,
- oldDisplay: Display) => void): this;
- removeListener(event: 'display-removed', listener: (event: Event,
- oldDisplay: Display) => void): this;
- /**
- * Converts a screen DIP point to a screen physical point. The DPI scale is
- * performed relative to the display containing the DIP point.
- *
- * @platform win32
- */
- dipToScreenPoint(point: Point): Point;
- /**
- * Converts a screen DIP rect to a screen physical rect. The DPI scale is performed
- * relative to the display nearest to `window`. If `window` is null, scaling will
- * be performed to the display nearest to `rect`.
- *
- * @platform win32
- */
- dipToScreenRect(window: (BrowserWindow) | (null), rect: Rectangle): Rectangle;
- /**
- * An array of displays that are currently available.
- */
- getAllDisplays(): Display[];
- /**
- * The current absolute position of the mouse pointer.
- */
- getCursorScreenPoint(): Point;
- /**
- * The display that most closely intersects the provided bounds.
- */
- getDisplayMatching(rect: Rectangle): Display;
- /**
- * The display nearest the specified point.
- */
- getDisplayNearestPoint(point: Point): Display;
- /**
- * The primary display.
- */
- getPrimaryDisplay(): Display;
- /**
- * Converts a screen physical point to a screen DIP point. The DPI scale is
- * performed relative to the display containing the physical point.
- *
- * @platform win32
- */
- screenToDipPoint(point: Point): Point;
- /**
- * Converts a screen physical rect to a screen DIP rect. The DPI scale is performed
- * relative to the display nearest to `window`. If `window` is null, scaling will
- * be performed to the display nearest to `rect`.
- *
- * @platform win32
- */
- screenToDipRect(window: (BrowserWindow) | (null), rect: Rectangle): Rectangle;
- }
-
- interface ScrubberItem {
-
- // Docs: http://electronjs.org/docs/api/structures/scrubber-item
-
- /**
- * The image to appear in this item.
- */
- icon?: NativeImage;
- /**
- * The text to appear in this item.
- */
- label?: string;
- }
-
- interface SegmentedControlSegment {
-
- // Docs: http://electronjs.org/docs/api/structures/segmented-control-segment
-
- /**
- * Whether this segment is selectable. Default: true.
- */
- enabled?: boolean;
- /**
- * The image to appear in this segment.
- */
- icon?: NativeImage;
- /**
- * The text to appear in this segment.
- */
- label?: string;
- }
-
- class Session extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/session
-
- /**
- * A session instance from `partition` string. When there is an existing `Session`
- * with the same `partition`, it will be returned; otherwise a new `Session`
- * instance will be created with `options`.
- *
- * If `partition` starts with `persist:`, the page will use a persistent session
- * available to all pages in the app with the same `partition`. if there is no
- * `persist:` prefix, the page will use an in-memory session. If the `partition` is
- * empty then default session of the app will be returned.
- *
- * To create a `Session` with `options`, you have to ensure the `Session` with the
- * `partition` has never been used before. There is no way to change the `options`
- * of an existing `Session` object.
- */
- static fromPartition(partition: string, options?: FromPartitionOptions): Session;
- /**
- * A `Session` object, the default session object of the app.
- */
- static defaultSession: Session;
- /**
- * Emitted when a render process requests preconnection to a URL, generally due to
- * a resource hint.
- *
- * @experimental
- */
- on(event: 'preconnect', listener: (event: Event,
- /**
- * The URL being requested for preconnection by the renderer.
- */
- preconnectUrl: string,
- /**
- * True if the renderer is requesting that the connection include credentials (see
- * the spec for more details.)
- */
- allowCredentials: boolean) => void): this;
- once(event: 'preconnect', listener: (event: Event,
- /**
- * The URL being requested for preconnection by the renderer.
- */
- preconnectUrl: string,
- /**
- * True if the renderer is requesting that the connection include credentials (see
- * the spec for more details.)
- */
- allowCredentials: boolean) => void): this;
- addListener(event: 'preconnect', listener: (event: Event,
- /**
- * The URL being requested for preconnection by the renderer.
- */
- preconnectUrl: string,
- /**
- * True if the renderer is requesting that the connection include credentials (see
- * the spec for more details.)
- */
- allowCredentials: boolean) => void): this;
- removeListener(event: 'preconnect', listener: (event: Event,
- /**
- * The URL being requested for preconnection by the renderer.
- */
- preconnectUrl: string,
- /**
- * True if the renderer is requesting that the connection include credentials (see
- * the spec for more details.)
- */
- allowCredentials: boolean) => void): this;
- /**
- * Emitted when Electron is about to download `item` in `webContents`.
- *
- * Calling `event.preventDefault()` will cancel the download and `item` will not be
- * available from next tick of the process.
- */
- on(event: 'will-download', listener: (event: Event,
- item: DownloadItem,
- webContents: WebContents) => void): this;
- once(event: 'will-download', listener: (event: Event,
- item: DownloadItem,
- webContents: WebContents) => void): this;
- addListener(event: 'will-download', listener: (event: Event,
- item: DownloadItem,
- webContents: WebContents) => void): this;
- removeListener(event: 'will-download', listener: (event: Event,
- item: DownloadItem,
- webContents: WebContents) => void): this;
- /**
- * Dynamically sets whether to always send credentials for HTTP NTLM or Negotiate
- * authentication.
- */
- allowNTLMCredentialsForDomains(domains: string): void;
- /**
- * resolves when the session’s HTTP authentication cache has been cleared.
- */
- clearAuthCache(options: (RemovePassword) | (RemoveClientCertificate)): Promise;
- /**
- * resolves when the cache clear operation is complete.
- *
-Clears the session’s HTTP cache.
- */
- clearCache(): Promise;
- /**
- * Resolves when the operation is complete.
-
-Clears the host resolver cache.
- */
- clearHostResolverCache(): Promise;
- /**
- * resolves when the storage data has been cleared.
- */
- clearStorageData(options?: ClearStorageDataOptions): Promise;
- /**
- * Allows resuming `cancelled` or `interrupted` downloads from previous `Session`.
- * The API will generate a DownloadItem that can be accessed with the will-download
- * event. The DownloadItem will not have any `WebContents` associated with it and
- * the initial state will be `interrupted`. The download will start only when the
- * `resume` API is called on the DownloadItem.
- */
- createInterruptedDownload(options: CreateInterruptedDownloadOptions): void;
- /**
- * Disables any network emulation already active for the `session`. Resets to the
- * original network configuration.
- */
- disableNetworkEmulation(): void;
- /**
- * Emulates network with the given configuration for the `session`.
- */
- enableNetworkEmulation(options: EnableNetworkEmulationOptions): void;
- /**
- * Writes any unwritten DOMStorage data to disk.
- */
- flushStorageData(): void;
- /**
- * resolves with blob data.
- */
- getBlobData(identifier: string): Promise;
- /**
- * the session's current cache size, in bytes.
- */
- getCacheSize(): Promise;
- /**
- * an array of paths to preload scripts that have been registered.
- */
- getPreloads(): string[];
- /**
- * The user agent for this session.
- */
- getUserAgent(): string;
- /**
- * Preconnects the given number of sockets to an origin.
- *
- * @experimental
- */
- preconnect(options: PreconnectOptions): void;
- /**
- * Resolves with the proxy information for `url`.
- */
- resolveProxy(url: string): Promise;
- /**
- * Sets the certificate verify proc for `session`, the `proc` will be called with
- * `proc(request, callback)` whenever a server certificate verification is
- * requested. Calling `callback(0)` accepts the certificate, calling `callback(-2)`
- * rejects it.
- *
- * Calling `setCertificateVerifyProc(null)` will revert back to default certificate
- * verify proc.
- */
- setCertificateVerifyProc(proc: (request: ProcRequest, callback: (verificationResult: number) => void) => void): void;
- /**
- * Sets download saving directory. By default, the download directory will be the
- * `Downloads` under the respective app folder.
- */
- setDownloadPath(path: string): void;
- /**
- * Sets the handler which can be used to respond to permission checks for the
- * `session`. Returning `true` will allow the permission and `false` will reject
- * it. To clear the handler, call `setPermissionCheckHandler(null)`.
- */
- setPermissionCheckHandler(handler: ((webContents: WebContents, permission: string, requestingOrigin: string, details: PermissionCheckHandlerHandlerDetails) => boolean) | (null)): void;
- /**
- * Sets the handler which can be used to respond to permission requests for the
- * `session`. Calling `callback(true)` will allow the permission and
- * `callback(false)` will reject it. To clear the handler, call
- * `setPermissionRequestHandler(null)`.
- */
- setPermissionRequestHandler(handler: ((webContents: WebContents, permission: string, callback: (permissionGranted: boolean) => void, details: PermissionRequestHandlerHandlerDetails) => void) | (null)): void;
- /**
- * Adds scripts that will be executed on ALL web contents that are associated with
- * this session just before normal `preload` scripts run.
- */
- setPreloads(preloads: string[]): void;
- /**
- * Resolves when the proxy setting process is complete.
- *
- * Sets the proxy settings.
- *
- * When `pacScript` and `proxyRules` are provided together, the `proxyRules` option
- * is ignored and `pacScript` configuration is applied.
- *
- * The `proxyRules` has to follow the rules below:
- *
- * For example:
- *
- * * `http=foopy:80;ftp=foopy2` - Use HTTP proxy `foopy:80` for `http://` URLs, and
- * HTTP proxy `foopy2:80` for `ftp://` URLs.
- * * `foopy:80` - Use HTTP proxy `foopy:80` for all URLs.
- * * `foopy:80,bar,direct://` - Use HTTP proxy `foopy:80` for all URLs, failing
- * over to `bar` if `foopy:80` is unavailable, and after that using no proxy.
- * * `socks4://foopy` - Use SOCKS v4 proxy `foopy:1080` for all URLs.
- * * `http=foopy,socks5://bar.com` - Use HTTP proxy `foopy` for http URLs, and fail
- * over to the SOCKS5 proxy `bar.com` if `foopy` is unavailable.
- * * `http=foopy,direct://` - Use HTTP proxy `foopy` for http URLs, and use no
- * proxy if `foopy` is unavailable.
- * * `http=foopy;socks=foopy2` - Use HTTP proxy `foopy` for http URLs, and use
- * `socks4://foopy2` for all other URLs.
- *
- * The `proxyBypassRules` is a comma separated list of rules described below:
- *
- * * `[ URL_SCHEME "://" ] HOSTNAME_PATTERN [ ":" ]`
- *
- * Match all hostnames that match the pattern HOSTNAME_PATTERN.
- *
- * Examples: "foobar.com", "*foobar.com", "*.foobar.com", "*foobar.com:99",
- * "https://x.*.y.com:99"
- * * `"." HOSTNAME_SUFFIX_PATTERN [ ":" PORT ]`
- *
- * Match a particular domain suffix.
- *
- * Examples: ".google.com", ".com", "http://.google.com"
- * * `[ SCHEME "://" ] IP_LITERAL [ ":" PORT ]`
- *
- * Match URLs which are IP address literals.
- *
- * Examples: "127.0.1", "[0:0::1]", "[::1]", "http://[::1]:99"
- * * `IP_LITERAL "/" PREFIX_LENGTH_IN_BITS`
- *
- * Match any URL that is to an IP literal that falls between the given range. IP
- * range is specified using CIDR notation.
- *
- * Examples: "192.168.1.1/16", "fefe:13::abc/33".
- * * ``
- *
- * Match local addresses. The meaning of `` is whether the host matches one
- * of: "127.0.0.1", "::1", "localhost".
- */
- setProxy(config: Config): Promise;
- /**
- * Overrides the `userAgent` and `acceptLanguages` for this session.
- *
- * The `acceptLanguages` must a comma separated ordered list of language codes, for
- * example `"en-US,fr,de,ko,zh-CN,ja"`.
- *
- * This doesn't affect existing `WebContents`, and each `WebContents` can use
- * `webContents.setUserAgent` to override the session-wide user agent.
- */
- setUserAgent(userAgent: string, acceptLanguages?: string): void;
- readonly cookies: Cookies;
- readonly netLog: NetLog;
- readonly protocol: Protocol;
- readonly webRequest: WebRequest;
- }
-
- interface Shell {
-
- // Docs: http://electronjs.org/docs/api/shell
-
- /**
- * Play the beep sound.
- */
- beep(): void;
- /**
- * Whether the item was successfully moved to the trash.
- *
-Move the given file to trash and returns a boolean status for the operation.
- */
- moveItemToTrash(fullPath: string): boolean;
- /**
- * Open the given external protocol URL in the desktop's default manner. (For
- * example, mailto: URLs in the user's default mail agent).
- */
- openExternal(url: string, options?: OpenExternalOptions): Promise;
- /**
- * Whether the item was successfully opened.
- *
-Open the given file in the desktop's default manner.
- */
- openItem(fullPath: string): boolean;
- /**
- * Resolves the shortcut link at `shortcutPath`.
- *
-An exception will be thrown when any error happens.
- *
- * @platform win32
- */
- readShortcutLink(shortcutPath: string): ShortcutDetails;
- /**
- * Show the given file in a file manager. If possible, select the file.
- */
- showItemInFolder(fullPath: string): void;
- /**
- * Whether the shortcut was created successfully.
- *
-Creates or updates a shortcut link at `shortcutPath`.
- *
- * @platform win32
- */
- writeShortcutLink(shortcutPath: string, operation: 'create' | 'update' | 'replace', options: ShortcutDetails): boolean;
- /**
- * Whether the shortcut was created successfully.
- *
-Creates or updates a shortcut link at `shortcutPath`.
- *
- * @platform win32
- */
- writeShortcutLink(shortcutPath: string, options: ShortcutDetails): boolean;
- }
-
- interface ShortcutDetails {
-
- // Docs: http://electronjs.org/docs/api/structures/shortcut-details
-
- /**
- * The Application User Model ID. Default is empty.
- */
- appUserModelId?: string;
- /**
- * The arguments to be applied to `target` when launching from this shortcut.
- * Default is empty.
- */
- args?: string;
- /**
- * The working directory. Default is empty.
- */
- cwd?: string;
- /**
- * The description of the shortcut. Default is empty.
- */
- description?: string;
- /**
- * The path to the icon, can be a DLL or EXE. `icon` and `iconIndex` have to be set
- * together. Default is empty, which uses the target's icon.
- */
- icon?: string;
- /**
- * The resource ID of icon when `icon` is a DLL or EXE. Default is 0.
- */
- iconIndex?: number;
- /**
- * The target to launch from this shortcut.
- */
- target: string;
- }
-
- interface Size {
-
- // Docs: http://electronjs.org/docs/api/structures/size
-
- height: number;
- width: number;
- }
-
- interface StreamProtocolResponse {
-
- // Docs: http://electronjs.org/docs/api/structures/stream-protocol-response
-
- /**
- * A Node.js readable stream representing the response body.
- */
- data: (NodeJS.ReadableStream) | (null);
- /**
- * An object containing the response headers.
- */
- headers?: Record;
- /**
- * The HTTP response code.
- */
- statusCode?: number;
- }
-
- interface StringProtocolResponse {
-
- // Docs: http://electronjs.org/docs/api/structures/string-protocol-response
-
- /**
- * Charset of the response.
- */
- charset?: string;
- /**
- * A string representing the response body.
- */
- data: (string) | (null);
- /**
- * MIME type of the response.
- */
- mimeType?: string;
- }
-
- interface SystemPreferences extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/system-preferences
-
- on(event: 'accent-color-changed', listener: (event: Event,
- /**
- * The new RGBA color the user assigned to be their system accent color.
- */
- newColor: string) => void): this;
- once(event: 'accent-color-changed', listener: (event: Event,
- /**
- * The new RGBA color the user assigned to be their system accent color.
- */
- newColor: string) => void): this;
- addListener(event: 'accent-color-changed', listener: (event: Event,
- /**
- * The new RGBA color the user assigned to be their system accent color.
- */
- newColor: string) => void): this;
- removeListener(event: 'accent-color-changed', listener: (event: Event,
- /**
- * The new RGBA color the user assigned to be their system accent color.
- */
- newColor: string) => void): this;
- on(event: 'color-changed', listener: (event: Event) => void): this;
- once(event: 'color-changed', listener: (event: Event) => void): this;
- addListener(event: 'color-changed', listener: (event: Event) => void): this;
- removeListener(event: 'color-changed', listener: (event: Event) => void): this;
- /**
- * **Deprecated:** Should use the new `updated` event on the `nativeTheme` module.
- *
- * @deprecated
- * @platform win32
- */
- on(event: 'high-contrast-color-scheme-changed', listener: (event: Event,
- /**
- * `true` if a high contrast theme is being used, `false` otherwise.
- */
- highContrastColorScheme: boolean) => void): this;
- once(event: 'high-contrast-color-scheme-changed', listener: (event: Event,
- /**
- * `true` if a high contrast theme is being used, `false` otherwise.
- */
- highContrastColorScheme: boolean) => void): this;
- addListener(event: 'high-contrast-color-scheme-changed', listener: (event: Event,
- /**
- * `true` if a high contrast theme is being used, `false` otherwise.
- */
- highContrastColorScheme: boolean) => void): this;
- removeListener(event: 'high-contrast-color-scheme-changed', listener: (event: Event,
- /**
- * `true` if a high contrast theme is being used, `false` otherwise.
- */
- highContrastColorScheme: boolean) => void): this;
- /**
- * **Deprecated:** Should use the new `updated` event on the `nativeTheme` module.
- *
- * @deprecated
- * @platform win32
- */
- on(event: 'inverted-color-scheme-changed', listener: (event: Event,
- /**
- * `true` if an inverted color scheme (a high contrast color scheme with light text
- * and dark backgrounds) is being used, `false` otherwise.
- */
- invertedColorScheme: boolean) => void): this;
- once(event: 'inverted-color-scheme-changed', listener: (event: Event,
- /**
- * `true` if an inverted color scheme (a high contrast color scheme with light text
- * and dark backgrounds) is being used, `false` otherwise.
- */
- invertedColorScheme: boolean) => void): this;
- addListener(event: 'inverted-color-scheme-changed', listener: (event: Event,
- /**
- * `true` if an inverted color scheme (a high contrast color scheme with light text
- * and dark backgrounds) is being used, `false` otherwise.
- */
- invertedColorScheme: boolean) => void): this;
- removeListener(event: 'inverted-color-scheme-changed', listener: (event: Event,
- /**
- * `true` if an inverted color scheme (a high contrast color scheme with light text
- * and dark backgrounds) is being used, `false` otherwise.
- */
- invertedColorScheme: boolean) => void): this;
- /**
- * A promise that resolves with `true` if consent was granted and `false` if it was
- * denied. If an invalid `mediaType` is passed, the promise will be rejected. If an
- * access request was denied and later is changed through the System Preferences
- * pane, a restart of the app will be required for the new permissions to take
- * effect. If access has already been requested and denied, it _must_ be changed
- * through the preference pane; an alert will not pop up and the promise will
- * resolve with the existing access status.
- *
- * **Important:** In order to properly leverage this API, you must set the
- * `NSMicrophoneUsageDescription` and `NSCameraUsageDescription` strings in your
- * app's `Info.plist` file. The values for these keys will be used to populate the
- * permission dialogs so that the user will be properly informed as to the purpose
- * of the permission request. See Electron Application Distribution for more
- * information about how to set these in the context of Electron.
- *
- * This user consent was not required until macOS 10.14 Mojave, so this method will
- * always return `true` if your system is running 10.13 High Sierra or lower.
- *
- * @platform darwin
- */
- askForMediaAccess(mediaType: 'microphone' | 'camera'): Promise;
- /**
- * whether or not this device has the ability to use Touch ID.
- *
- * **NOTE:** This API will return `false` on macOS systems older than Sierra
- * 10.12.2.
-
-**Deprecated**
- *
- * @platform darwin
- */
- canPromptTouchID(): boolean;
- /**
- * The users current system wide accent color preference in RGBA hexadecimal form.
- *
-This API is only available on macOS 10.14 Mojave or newer.
- *
- * @platform win32,darwin
- */
- getAccentColor(): string;
- /**
- * * `shouldRenderRichAnimation` Boolean - Returns true if rich animations should
- * be rendered. Looks at session type (e.g. remote desktop) and accessibility
- * settings to give guidance for heavy animations.
- * * `scrollAnimationsEnabledBySystem` Boolean - Determines on a per-platform basis
- * whether scroll animations (e.g. produced by home/end key) should be enabled.
- * * `prefersReducedMotion` Boolean - Determines whether the user desires reduced
- * motion based on platform APIs.
- *
-Returns an object with system animation settings.
- */
- getAnimationSettings(): AnimationSettings;
- /**
- * | `null` - Can be `dark`, `light` or `unknown`.
- *
- * Gets the macOS appearance setting that you have declared you want for your
- * application, maps to NSApplication.appearance. You can use the
- * `setAppLevelAppearance` API to set this value.
-
-**Deprecated**
- *
- * @deprecated
- * @platform darwin
- */
- getAppLevelAppearance(): ('dark' | 'light' | 'unknown');
- /**
- * The system color setting in RGB hexadecimal form (`#ABCDEF`). See the Windows
- * docs and the MacOS docs for more details.
- *
- * @platform win32,darwin
- */
- getColor(color: '3d-dark-shadow' | '3d-face' | '3d-highlight' | '3d-light' | '3d-shadow' | 'active-border' | 'active-caption' | 'active-caption-gradient' | 'app-workspace' | 'button-text' | 'caption-text' | 'desktop' | 'disabled-text' | 'highlight' | 'highlight-text' | 'hotlight' | 'inactive-border' | 'inactive-caption' | 'inactive-caption-gradient' | 'inactive-caption-text' | 'info-background' | 'info-text' | 'menu' | 'menu-highlight' | 'menubar' | 'menu-text' | 'scrollbar' | 'window' | 'window-frame' | 'window-text' | 'alternate-selected-control-text' | 'control-background' | 'control' | 'control-text' | 'disabled-control-text' | 'find-highlight' | 'grid' | 'header-text' | 'highlight' | 'keyboard-focus-indicator' | 'label' | 'link' | 'placeholder-text' | 'quaternary-label' | 'scrubber-textured-background' | 'secondary-label' | 'selected-content-background' | 'selected-control' | 'selected-control-text' | 'selected-menu-item' | 'selected-text-background' | 'selected-text' | 'separator' | 'shadow' | 'tertiary-label' | 'text-background' | 'text' | 'under-page-background' | 'unemphasized-selected-content-background' | 'unemphasized-selected-text-background' | 'unemphasized-selected-text' | 'window-background' | 'window-frame-text'): string;
- /**
- * Can be `dark`, `light` or `unknown`.
- *
- * Gets the macOS appearance setting that is currently applied to your application,
- * maps to NSApplication.effectiveAppearance
- *
- * Please note that until Electron is built targeting the 10.14 SDK, your
- * application's `effectiveAppearance` will default to 'light' and won't inherit
- * the OS preference. In the interim in order for your application to inherit the
- * OS preference you must set the `NSRequiresAquaSystemAppearance` key in your apps
- * `Info.plist` to `false`. If you are using `electron-packager` or
- * `electron-forge` just set the `enableDarwinDarkMode` packager option to `true`.
- * See the Electron Packager API for more details.
-
-**Deprecated**
- *
- * @platform darwin
- */
- getEffectiveAppearance(): ('dark' | 'light' | 'unknown');
- /**
- * Can be `not-determined`, `granted`, `denied`, `restricted` or `unknown`.
- *
- * This user consent was not required until macOS 10.14 Mojave, so this method will
- * always return `granted` if your system is running 10.13 High Sierra or lower.
- *
- * @platform darwin
- */
- getMediaAccessStatus(mediaType: string): ('not-determined' | 'granted' | 'denied' | 'restricted' | 'unknown');
- /**
- * The standard system color formatted as `#RRGGBBAA`.
- *
- * Returns one of several standard system colors that automatically adapt to
- * vibrancy and changes in accessibility settings like 'Increase contrast' and
- * 'Reduce transparency'. See Apple Documentation for more details.
- *
- * @platform darwin
- */
- getSystemColor(color: 'blue' | 'brown' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow'): string;
- /**
- * The value of `key` in `NSUserDefaults`.
- *
- * Some popular `key` and `type`s are:
- *
- * * `AppleInterfaceStyle`: `string`
- * * `AppleAquaColorVariant`: `integer`
- * * `AppleHighlightColor`: `string`
- * * `AppleShowScrollBars`: `string`
- * * `NSNavRecentPlaces`: `array`
- * * `NSPreferredWebServices`: `dictionary`
- * * `NSUserDictionaryReplacementItems`: `array`
- *
- * @platform darwin
- */
- getUserDefault(key: string, type: 'string' | 'boolean' | 'integer' | 'float' | 'double' | 'url' | 'array' | 'dictionary'): any;
- /**
- * `true` if DWM composition (Aero Glass) is enabled, and `false` otherwise.
- *
- * An example of using it to determine if you should create a transparent window or
- * not (transparent windows won't work correctly when DWM composition is disabled):
- *
- * @platform win32
- */
- isAeroGlassEnabled(): boolean;
- /**
- * Whether the system is in Dark Mode.
- *
- * **Note:** On macOS 10.15 Catalina in order for this API to return the correct
- * value when in the "automatic" dark mode setting you must either have
- * `NSRequiresAquaSystemAppearance=false` in your `Info.plist` or be on Electron
- * `>=7.0.0`. See the dark mode guide for more information.
- *
-**Deprecated:** Should use the new `nativeTheme.shouldUseDarkColors` API.
- *
- * @deprecated
- * @platform darwin,win32
- */
- isDarkMode(): boolean;
- /**
- * `true` if a high contrast theme is active, `false` otherwise.
- *
- * **Depreacted:** Should use the new `nativeTheme.shouldUseHighContrastColors`
- * API.
- *
- * @deprecated
- * @platform darwin,win32
- */
- isHighContrastColorScheme(): boolean;
- /**
- * `true` if an inverted color scheme (a high contrast color scheme with light text
- * and dark backgrounds) is active, `false` otherwise.
- *
- * **Deprecated:** Should use the new `nativeTheme.shouldUseInvertedColorScheme`
- * API.
- *
- * @deprecated
- * @platform win32
- */
- isInvertedColorScheme(): boolean;
- /**
- * Whether the Swipe between pages setting is on.
- *
- * @platform darwin
- */
- isSwipeTrackingFromScrollEventsEnabled(): boolean;
- /**
- * `true` if the current process is a trusted accessibility client and `false` if
- * it is not.
- *
- * @platform darwin
- */
- isTrustedAccessibilityClient(prompt: boolean): boolean;
- /**
- * Posts `event` as native notifications of macOS. The `userInfo` is an Object that
- * contains the user information dictionary sent along with the notification.
- *
- * @platform darwin
- */
- postLocalNotification(event: string, userInfo: Record): void;
- /**
- * Posts `event` as native notifications of macOS. The `userInfo` is an Object that
- * contains the user information dictionary sent along with the notification.
- *
- * @platform darwin
- */
- postNotification(event: string, userInfo: Record, deliverImmediately?: boolean): void;
- /**
- * Posts `event` as native notifications of macOS. The `userInfo` is an Object that
- * contains the user information dictionary sent along with the notification.
- *
- * @platform darwin
- */
- postWorkspaceNotification(event: string, userInfo: Record): void;
- /**
- * resolves if the user has successfully authenticated with Touch ID.
- *
- * This API itself will not protect your user data; rather, it is a mechanism to
- * allow you to do so. Native apps will need to set Access Control Constants like
- * `kSecAccessControlUserPresence` on the their keychain entry so that reading it
- * would auto-prompt for Touch ID biometric consent. This could be done with
- * `node-keytar`, such that one would store an encryption key with `node-keytar`
- * and only fetch it if `promptTouchID()` resolves.
- *
- * **NOTE:** This API will return a rejected Promise on macOS systems older than
- * Sierra 10.12.2.
- *
- * @platform darwin
- */
- promptTouchID(reason: string): Promise;
- /**
- * Add the specified defaults to your application's `NSUserDefaults`.
- *
- * @platform darwin
- */
- registerDefaults(defaults: Record): void;
- /**
- * Removes the `key` in `NSUserDefaults`. This can be used to restore the default
- * or global value of a `key` previously set with `setUserDefault`.
- *
- * @platform darwin
- */
- removeUserDefault(key: string): void;
- /**
- * Sets the appearance setting for your application, this should override the
- * system default and override the value of `getEffectiveAppearance`.
- *
-**Deprecated**
- *
- * @deprecated
- * @platform darwin
- */
- setAppLevelAppearance(appearance: (('dark' | 'light')) | (null)): void;
- /**
- * Set the value of `key` in `NSUserDefaults`.
- *
- * Note that `type` should match actual type of `value`. An exception is thrown if
- * they don't.
- *
-Some popular `key` and `type`s are:
-
-* `ApplePressAndHoldEnabled`: `boolean`
- *
- * @platform darwin
- */
- setUserDefault(key: string, type: string, value: string): void;
- /**
- * The ID of this subscription
- *
- * Same as `subscribeNotification`, but uses `NSNotificationCenter` for local
- * defaults. This is necessary for events such as
- * `NSUserDefaultsDidChangeNotification`.
- *
- * @platform darwin
- */
- subscribeLocalNotification(event: string, callback: (event: string, userInfo: Record, object: string) => void): number;
- /**
- * The ID of this subscription
- *
- * Subscribes to native notifications of macOS, `callback` will be called with
- * `callback(event, userInfo)` when the corresponding `event` happens. The
- * `userInfo` is an Object that contains the user information dictionary sent along
- * with the notification. The `object` is the sender of the notification, and only
- * supports `NSString` values for now.
- *
- * The `id` of the subscriber is returned, which can be used to unsubscribe the
- * `event`.
- *
- * Under the hood this API subscribes to `NSDistributedNotificationCenter`, example
- * values of `event` are:
- *
- * * `AppleInterfaceThemeChangedNotification`
- * * `AppleAquaColorVariantChanged`
- * * `AppleColorPreferencesChangedNotification`
- * * `AppleShowScrollBarsSettingChanged`
- *
- * @platform darwin
- */
- subscribeNotification(event: string, callback: (event: string, userInfo: Record, object: string) => void): number;
- /**
- * Same as `subscribeNotification`, but uses
- * `NSWorkspace.sharedWorkspace.notificationCenter`. This is necessary for events
- * such as `NSWorkspaceDidActivateApplicationNotification`.
- *
- * @platform darwin
- */
- subscribeWorkspaceNotification(event: string, callback: (event: string, userInfo: Record, object: string) => void): void;
- /**
- * Same as `unsubscribeNotification`, but removes the subscriber from
- * `NSNotificationCenter`.
- *
- * @platform darwin
- */
- unsubscribeLocalNotification(id: number): void;
- /**
- * Removes the subscriber with `id`.
- *
- * @platform darwin
- */
- unsubscribeNotification(id: number): void;
- /**
- * Same as `unsubscribeNotification`, but removes the subscriber from
- * `NSWorkspace.sharedWorkspace.notificationCenter`.
- *
- * @platform darwin
- */
- unsubscribeWorkspaceNotification(id: number): void;
- /**
- * A `String` property that can be `dark`, `light` or `unknown`. It determines the
- * macOS appearance setting for your application. This maps to values in:
- * NSApplication.appearance. Setting this will override the system default as well
- * as the value of `getEffectiveAppearance`.
- *
- * Possible values that can be set are `dark` and `light`, and possible return
- * values are `dark`, `light`, and `unknown`.
- *
-This property is only available on macOS 10.14 Mojave or newer.
- *
- * @platform darwin
- */
- appLevelAppearance: ('dark' | 'light' | 'unknown');
- /**
- * A `String` property that can be `dark`, `light` or `unknown`.
- *
- * Returns the macOS appearance setting that is currently applied to your
- * application, maps to NSApplication.effectiveAppearance
- *
- * Please note that until Electron is built targeting the 10.14 SDK, your
- * application's `effectiveAppearance` will default to 'light' and won't inherit
- * the OS preference. In the interim in order for your application to inherit the
- * OS preference you must set the `NSRequiresAquaSystemAppearance` key in your apps
- * `Info.plist` to `false`. If you are using `electron-packager` or
- * `electron-forge` just set the `enableDarwinDarkMode` packager option to `true`.
- * See the Electron Packager API for more details.
- *
- * @platform darwin
- */
- readonly effectiveAppearance: ('dark' | 'light' | 'unknown');
- }
-
- interface Task {
-
- // Docs: http://electronjs.org/docs/api/structures/task
-
- /**
- * The command line arguments when `program` is executed.
- */
- arguments: string;
- /**
- * Description of this task.
- */
- description: string;
- /**
- * The icon index in the icon file. If an icon file consists of two or more icons,
- * set this value to identify the icon. If an icon file consists of one icon, this
- * value is 0.
- */
- iconIndex: number;
- /**
- * The absolute path to an icon to be displayed in a JumpList, which can be an
- * arbitrary resource file that contains an icon. You can usually specify
- * `process.execPath` to show the icon of the program.
- */
- iconPath: string;
- /**
- * Path of the program to execute, usually you should specify `process.execPath`
- * which opens the current program.
- */
- program: string;
- /**
- * The string to be displayed in a JumpList.
- */
- title: string;
- /**
- * The working directory. Default is empty.
- */
- workingDirectory?: string;
- }
-
- interface ThumbarButton {
-
- // Docs: http://electronjs.org/docs/api/structures/thumbar-button
-
- click: Function;
- /**
- * Control specific states and behaviors of the button. By default, it is
- * `['enabled']`.
- */
- flags?: string[];
- /**
- * The icon showing in thumbnail toolbar.
- */
- icon: NativeImage;
- /**
- * The text of the button's tooltip.
- */
- tooltip?: string;
- }
-
- class TouchBar {
-
- // Docs: http://electronjs.org/docs/api/touch-bar
-
- /**
- * TouchBar
- */
- constructor(options: TouchBarConstructorOptions);
- escapeItem: (TouchBarButton | TouchBarColorPicker | TouchBarGroup | TouchBarLabel | TouchBarPopover | TouchBarScrubber | TouchBarSegmentedControl | TouchBarSlider | TouchBarSpacer | null);
- static TouchBarButton: typeof TouchBarButton;
- static TouchBarColorPicker: typeof TouchBarColorPicker;
- static TouchBarGroup: typeof TouchBarGroup;
- static TouchBarLabel: typeof TouchBarLabel;
- static TouchBarPopover: typeof TouchBarPopover;
- static TouchBarScrubber: typeof TouchBarScrubber;
- static TouchBarSegmentedControl: typeof TouchBarSegmentedControl;
- static TouchBarSlider: typeof TouchBarSlider;
- static TouchBarSpacer: typeof TouchBarSpacer;
- }
-
- class TouchBarButton {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-button
-
- /**
- * TouchBarButton
- */
- constructor(options: TouchBarButtonConstructorOptions);
- backgroundColor: string;
- icon: NativeImage;
- label: string;
- }
-
- class TouchBarColorPicker extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-color-picker
-
- /**
- * TouchBarColorPicker
- */
- constructor(options: TouchBarColorPickerConstructorOptions);
- availableColors: string[];
- selectedColor: string;
- }
-
- class TouchBarGroup extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-group
-
- /**
- * TouchBarGroup
- */
- constructor(options: TouchBarGroupConstructorOptions);
- }
-
- class TouchBarLabel extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-label
-
- /**
- * TouchBarLabel
- */
- constructor(options: TouchBarLabelConstructorOptions);
- label: string;
- textColor: string;
- }
-
- class TouchBarPopover extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-popover
-
- /**
- * TouchBarPopover
- */
- constructor(options: TouchBarPopoverConstructorOptions);
- icon: NativeImage;
- label: string;
- }
-
- class TouchBarScrubber extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-scrubber
-
- /**
- * TouchBarScrubber
- */
- constructor(options: TouchBarScrubberConstructorOptions);
- continuous: boolean;
- items: ScrubberItem[];
- mode: ('fixed' | 'free');
- overlayStyle: ('background' | 'outline' | 'null');
- selectedStyle: ('background' | 'outline' | 'null');
- showArrowButtons: boolean;
- }
-
- class TouchBarSegmentedControl extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-segmented-control
-
- /**
- * TouchBarSegmentedControl
- */
- constructor(options: TouchBarSegmentedControlConstructorOptions);
- segments: SegmentedControlSegment[];
- segmentStyle: string;
- selectedIndex: number;
- }
-
- class TouchBarSlider extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-slider
-
- /**
- * TouchBarSlider
- */
- constructor(options: TouchBarSliderConstructorOptions);
- label: string;
- maxValue: number;
- minValue: number;
- value: number;
- }
-
- class TouchBarSpacer extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar-spacer
-
- /**
- * TouchBarSpacer
- */
- constructor(options: TouchBarSpacerConstructorOptions);
- }
-
- interface TraceCategoriesAndOptions {
-
- // Docs: http://electronjs.org/docs/api/structures/trace-categories-and-options
-
- /**
- * A filter to control what category groups should be traced. A filter can have an
- * optional '-' prefix to exclude category groups that contain a matching category.
- * Having both included and excluded category patterns in the same list is not
- * supported. Examples: `test_MyTest*`, `test_MyTest*,test_OtherStuff`,
- * `-excluded_category1,-excluded_category2`.
- */
- categoryFilter: string;
- /**
- * Controls what kind of tracing is enabled, it is a comma-delimited sequence of
- * the following strings: `record-until-full`, `record-continuously`,
- * `trace-to-console`, `enable-sampling`, `enable-systrace`, e.g.
- * `'record-until-full,enable-sampling'`. The first 3 options are trace recording
- * modes and hence mutually exclusive. If more than one trace recording modes
- * appear in the `traceOptions` string, the last one takes precedence. If none of
- * the trace recording modes are specified, recording mode is `record-until-full`.
- * The trace option will first be reset to the default option (`record_mode` set to
- * `record-until-full`, `enable_sampling` and `enable_systrace` set to `false`)
- * before options parsed from `traceOptions` are applied on it.
- */
- traceOptions: string;
- }
-
- interface TraceConfig {
-
- // Docs: http://electronjs.org/docs/api/structures/trace-config
-
- /**
- * if true, filter event data according to a whitelist of events that have been
- * manually vetted to not include any PII. See the implementation in Chromium for
- * specifics.
- */
- enable_argument_filter?: boolean;
- /**
- * a list of tracing categories to exclude. Can include glob-like patterns using
- * `*` at the end of the category name. See tracing categories for the list of
- * categories.
- */
- excluded_categories?: string[];
- /**
- * a list of histogram names to report with the trace.
- */
- histogram_names?: string[];
- /**
- * a list of tracing categories to include. Can include glob-like patterns using
- * `*` at the end of the category name. See tracing categories for the list of
- * categories.
- */
- included_categories?: string[];
- /**
- * a list of process IDs to include in the trace. If not specified, trace all
- * processes.
- */
- included_process_ids?: number[];
- /**
- * if the `disabled-by-default-memory-infra` category is enabled, this contains
- * optional additional configuration for data collection. See the Chromium
- * memory-infra docs for more information.
- */
- memory_dump_config?: Record;
- /**
- * Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible`
- * or `trace-to-console`. Defaults to `record-until-full`.
- */
- recording_mode?: ('record-until-full' | 'record-continuously' | 'record-as-much-as-possible' | 'trace-to-console');
- /**
- * maximum size of the trace recording buffer in events.
- */
- trace_buffer_size_in_events?: number;
- /**
- * maximum size of the trace recording buffer in kilobytes. Defaults to 100MB.
- */
- trace_buffer_size_in_kb?: number;
- }
-
- interface Transaction {
-
- // Docs: http://electronjs.org/docs/api/structures/transaction
-
- /**
- * The error code if an error occurred while processing the transaction.
- */
- errorCode: number;
- /**
- * The error message if an error occurred while processing the transaction.
- */
- errorMessage: string;
- /**
- * The identifier of the restored transaction by the App Store.
- */
- originalTransactionIdentifier: string;
- payment: Payment;
- /**
- * The date the transaction was added to the App Store’s payment queue.
- */
- transactionDate: string;
- /**
- * A string that uniquely identifies a successful payment transaction.
- */
- transactionIdentifier: string;
- /**
- * The transaction state, can be `purchasing`, `purchased`, `failed`, `restored` or
- * `deferred`.
- */
- transactionState: ('purchasing' | 'purchased' | 'failed' | 'restored' | 'deferred');
- }
-
- class Tray extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/tray
-
- /**
- * Emitted when the tray balloon is clicked.
- *
- * @platform win32
- */
- on(event: 'balloon-click', listener: Function): this;
- once(event: 'balloon-click', listener: Function): this;
- addListener(event: 'balloon-click', listener: Function): this;
- removeListener(event: 'balloon-click', listener: Function): this;
- /**
- * Emitted when the tray balloon is closed because of timeout or user manually
- * closes it.
- *
- * @platform win32
- */
- on(event: 'balloon-closed', listener: Function): this;
- once(event: 'balloon-closed', listener: Function): this;
- addListener(event: 'balloon-closed', listener: Function): this;
- removeListener(event: 'balloon-closed', listener: Function): this;
- /**
- * Emitted when the tray balloon shows.
- *
- * @platform win32
- */
- on(event: 'balloon-show', listener: Function): this;
- once(event: 'balloon-show', listener: Function): this;
- addListener(event: 'balloon-show', listener: Function): this;
- removeListener(event: 'balloon-show', listener: Function): this;
- /**
- * Emitted when the tray icon is clicked.
- */
- on(event: 'click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- once(event: 'click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- addListener(event: 'click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- removeListener(event: 'click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- /**
- * Emitted when the tray icon is double clicked.
- *
- * @platform darwin,win32
- */
- on(event: 'double-click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle) => void): this;
- once(event: 'double-click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle) => void): this;
- addListener(event: 'double-click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle) => void): this;
- removeListener(event: 'double-click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle) => void): this;
- /**
- * Emitted when a drag operation ends on the tray or ends at another location.
- *
- * @platform darwin
- */
- on(event: 'drag-end', listener: Function): this;
- once(event: 'drag-end', listener: Function): this;
- addListener(event: 'drag-end', listener: Function): this;
- removeListener(event: 'drag-end', listener: Function): this;
- /**
- * Emitted when a drag operation enters the tray icon.
- *
- * @platform darwin
- */
- on(event: 'drag-enter', listener: Function): this;
- once(event: 'drag-enter', listener: Function): this;
- addListener(event: 'drag-enter', listener: Function): this;
- removeListener(event: 'drag-enter', listener: Function): this;
- /**
- * Emitted when a drag operation exits the tray icon.
- *
- * @platform darwin
- */
- on(event: 'drag-leave', listener: Function): this;
- once(event: 'drag-leave', listener: Function): this;
- addListener(event: 'drag-leave', listener: Function): this;
- removeListener(event: 'drag-leave', listener: Function): this;
- /**
- * Emitted when any dragged items are dropped on the tray icon.
- *
- * @platform darwin
- */
- on(event: 'drop', listener: Function): this;
- once(event: 'drop', listener: Function): this;
- addListener(event: 'drop', listener: Function): this;
- removeListener(event: 'drop', listener: Function): this;
- /**
- * Emitted when dragged files are dropped in the tray icon.
- *
- * @platform darwin
- */
- on(event: 'drop-files', listener: (event: Event,
- /**
- * The paths of the dropped files.
- */
- files: string[]) => void): this;
- once(event: 'drop-files', listener: (event: Event,
- /**
- * The paths of the dropped files.
- */
- files: string[]) => void): this;
- addListener(event: 'drop-files', listener: (event: Event,
- /**
- * The paths of the dropped files.
- */
- files: string[]) => void): this;
- removeListener(event: 'drop-files', listener: (event: Event,
- /**
- * The paths of the dropped files.
- */
- files: string[]) => void): this;
- /**
- * Emitted when dragged text is dropped in the tray icon.
- *
- * @platform darwin
- */
- on(event: 'drop-text', listener: (event: Event,
- /**
- * the dropped text string.
- */
- text: string) => void): this;
- once(event: 'drop-text', listener: (event: Event,
- /**
- * the dropped text string.
- */
- text: string) => void): this;
- addListener(event: 'drop-text', listener: (event: Event,
- /**
- * the dropped text string.
- */
- text: string) => void): this;
- removeListener(event: 'drop-text', listener: (event: Event,
- /**
- * the dropped text string.
- */
- text: string) => void): this;
- /**
- * Emitted when the mouse enters the tray icon.
- *
- * @platform darwin
- */
- on(event: 'mouse-enter', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- once(event: 'mouse-enter', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- addListener(event: 'mouse-enter', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- removeListener(event: 'mouse-enter', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- /**
- * Emitted when the mouse exits the tray icon.
- *
- * @platform darwin
- */
- on(event: 'mouse-leave', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- once(event: 'mouse-leave', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- addListener(event: 'mouse-leave', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- removeListener(event: 'mouse-leave', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- /**
- * Emitted when the mouse moves in the tray icon.
- *
- * @platform darwin,win32
- */
- on(event: 'mouse-move', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- once(event: 'mouse-move', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- addListener(event: 'mouse-move', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- removeListener(event: 'mouse-move', listener: (event: KeyboardEvent,
- /**
- * The position of the event.
- */
- position: Point) => void): this;
- /**
- * Emitted when the tray icon is right clicked.
- *
- * @platform darwin,win32
- */
- on(event: 'right-click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle) => void): this;
- once(event: 'right-click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle) => void): this;
- addListener(event: 'right-click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle) => void): this;
- removeListener(event: 'right-click', listener: (event: KeyboardEvent,
- /**
- * The bounds of tray icon.
- */
- bounds: Rectangle) => void): this;
- /**
- * Tray
- */
- constructor(image: (NativeImage) | (string));
- /**
- * Destroys the tray icon immediately.
- */
- destroy(): void;
- /**
- * Displays a tray balloon.
- *
- * @platform win32
- */
- displayBalloon(options: DisplayBalloonOptions): void;
- /**
- * The `bounds` of this tray icon as `Object`.
- *
- * @platform darwin,win32
- */
- getBounds(): Rectangle;
- /**
- * Whether double click events will be ignored.
- *
- * @platform darwin
- */
- getIgnoreDoubleClickEvents(): boolean;
- /**
- * the title displayed next to the tray icon in the status bar
- *
- * @platform darwin
- */
- getTitle(): string;
- /**
- * Whether the tray icon is destroyed.
- */
- isDestroyed(): boolean;
- /**
- * Pops up the context menu of the tray icon. When `menu` is passed, the `menu`
- * will be shown instead of the tray icon's context menu.
- *
-The `position` is only available on Windows, and it is (0, 0) by default.
- *
- * @platform darwin,win32
- */
- popUpContextMenu(menu?: Menu, position?: Point): void;
- /**
- * Sets the context menu for this icon.
- */
- setContextMenu(menu: (Menu) | (null)): void;
- /**
- * Sets the option to ignore double click events. Ignoring these events allows you
- * to detect every individual click of the tray icon.
- *
-This value is set to false by default.
- *
- * @platform darwin
- */
- setIgnoreDoubleClickEvents(ignore: boolean): void;
- /**
- * Sets the `image` associated with this tray icon.
- */
- setImage(image: (NativeImage) | (string)): void;
- /**
- * Sets the `image` associated with this tray icon when pressed on macOS.
- *
- * @platform darwin
- */
- setPressedImage(image: (NativeImage) | (string)): void;
- /**
- * Sets the title displayed next to the tray icon in the status bar (Support ANSI
- * colors).
- *
- * @platform darwin
- */
- setTitle(title: string): void;
- /**
- * Sets the hover text for this tray icon.
- */
- setToolTip(toolTip: string): void;
- }
-
- interface UploadBlob {
-
- // Docs: http://electronjs.org/docs/api/structures/upload-blob
-
- /**
- * UUID of blob data to upload.
- */
- blobUUID: string;
- /**
- * `blob`.
- */
- type: string;
- }
-
- interface UploadData {
-
- // Docs: http://electronjs.org/docs/api/structures/upload-data
-
- /**
- * UUID of blob data. Use ses.getBlobData method to retrieve the data.
- */
- blobUUID?: string;
- /**
- * Content being sent.
- */
- bytes: Buffer;
- /**
- * Path of file being uploaded.
- */
- file?: string;
- }
-
- interface UploadFile {
-
- // Docs: http://electronjs.org/docs/api/structures/upload-file
-
- /**
- * Path of file to be uploaded.
- */
- filePath: string;
- /**
- * Number of bytes to read from `offset`. Defaults to `0`.
- */
- length: number;
- /**
- * Last Modification time in number of seconds since the UNIX epoch.
- */
- modificationTime: number;
- /**
- * Defaults to `0`.
- */
- offset: number;
- /**
- * `file`.
- */
- type: string;
- }
-
- interface UploadRawData {
-
- // Docs: http://electronjs.org/docs/api/structures/upload-raw-data
-
- /**
- * Data to be uploaded.
- */
- bytes: Buffer;
- /**
- * `rawData`.
- */
- type: string;
- }
-
- class WebContents extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/web-contents
-
- /**
- * A WebContents instance with the given ID.
- */
- static fromId(id: number): WebContents;
- /**
- * An array of all `WebContents` instances. This will contain web contents for all
- * windows, webviews, opened devtools, and devtools extension background pages.
- */
- static getAllWebContents(): WebContents[];
- /**
- * The web contents that is focused in this application, otherwise returns `null`.
- */
- static getFocusedWebContents(): WebContents;
- /**
- * Emitted before dispatching the `keydown` and `keyup` events in the page. Calling
- * `event.preventDefault` will prevent the page `keydown`/`keyup` events and the
- * menu shortcuts.
- *
-To only prevent the menu shortcuts, use `setIgnoreMenuShortcuts`:
- */
- on(event: 'before-input-event', listener: (event: Event,
- /**
- * Input properties.
- */
- input: Input) => void): this;
- once(event: 'before-input-event', listener: (event: Event,
- /**
- * Input properties.
- */
- input: Input) => void): this;
- addListener(event: 'before-input-event', listener: (event: Event,
- /**
- * Input properties.
- */
- input: Input) => void): this;
- removeListener(event: 'before-input-event', listener: (event: Event,
- /**
- * Input properties.
- */
- input: Input) => void): this;
- /**
- * Emitted when failed to verify the `certificate` for `url`.
- *
-The usage is the same with the `certificate-error` event of `app`.
- */
- on(event: 'certificate-error', listener: (event: Event,
- url: string,
- /**
- * The error code.
- */
- error: string,
- certificate: Certificate,
- callback: (isTrusted: boolean) => void) => void): this;
- once(event: 'certificate-error', listener: (event: Event,
- url: string,
- /**
- * The error code.
- */
- error: string,
- certificate: Certificate,
- callback: (isTrusted: boolean) => void) => void): this;
- addListener(event: 'certificate-error', listener: (event: Event,
- url: string,
- /**
- * The error code.
- */
- error: string,
- certificate: Certificate,
- callback: (isTrusted: boolean) => void) => void): this;
- removeListener(event: 'certificate-error', listener: (event: Event,
- url: string,
- /**
- * The error code.
- */
- error: string,
- certificate: Certificate,
- callback: (isTrusted: boolean) => void) => void): this;
- /**
- * Emitted when the associated window logs a console message. Will not be emitted
- * for windows with *offscreen rendering* enabled.
- */
- on(event: 'console-message', listener: (event: Event,
- level: number,
- message: string,
- line: number,
- sourceId: string) => void): this;
- once(event: 'console-message', listener: (event: Event,
- level: number,
- message: string,
- line: number,
- sourceId: string) => void): this;
- addListener(event: 'console-message', listener: (event: Event,
- level: number,
- message: string,
- line: number,
- sourceId: string) => void): this;
- removeListener(event: 'console-message', listener: (event: Event,
- level: number,
- message: string,
- line: number,
- sourceId: string) => void): this;
- /**
- * Emitted when there is a new context menu that needs to be handled.
- */
- on(event: 'context-menu', listener: (event: Event,
- params: ContextMenuParams) => void): this;
- once(event: 'context-menu', listener: (event: Event,
- params: ContextMenuParams) => void): this;
- addListener(event: 'context-menu', listener: (event: Event,
- params: ContextMenuParams) => void): this;
- removeListener(event: 'context-menu', listener: (event: Event,
- params: ContextMenuParams) => void): this;
- /**
- * Emitted when the renderer process crashes or is killed.
- */
- on(event: 'crashed', listener: (event: Event,
- killed: boolean) => void): this;
- once(event: 'crashed', listener: (event: Event,
- killed: boolean) => void): this;
- addListener(event: 'crashed', listener: (event: Event,
- killed: boolean) => void): this;
- removeListener(event: 'crashed', listener: (event: Event,
- killed: boolean) => void): this;
- /**
- * Emitted when the cursor's type changes. The `type` parameter can be `default`,
- * `crosshair`, `pointer`, `text`, `wait`, `help`, `e-resize`, `n-resize`,
- * `ne-resize`, `nw-resize`, `s-resize`, `se-resize`, `sw-resize`, `w-resize`,
- * `ns-resize`, `ew-resize`, `nesw-resize`, `nwse-resize`, `col-resize`,
- * `row-resize`, `m-panning`, `e-panning`, `n-panning`, `ne-panning`, `nw-panning`,
- * `s-panning`, `se-panning`, `sw-panning`, `w-panning`, `move`, `vertical-text`,
- * `cell`, `context-menu`, `alias`, `progress`, `nodrop`, `copy`, `none`,
- * `not-allowed`, `zoom-in`, `zoom-out`, `grab`, `grabbing` or `custom`.
- *
- * If the `type` parameter is `custom`, the `image` parameter will hold the custom
- * cursor image in a `NativeImage`, and `scale`, `size` and `hotspot` will hold
- * additional information about the custom cursor.
- */
- on(event: 'cursor-changed', listener: (event: Event,
- type: string,
- image: NativeImage,
- /**
- * scaling factor for the custom cursor.
- */
- scale: number,
- /**
- * the size of the `image`.
- */
- size: Size,
- /**
- * coordinates of the custom cursor's hotspot.
- */
- hotspot: Point) => void): this;
- once(event: 'cursor-changed', listener: (event: Event,
- type: string,
- image: NativeImage,
- /**
- * scaling factor for the custom cursor.
- */
- scale: number,
- /**
- * the size of the `image`.
- */
- size: Size,
- /**
- * coordinates of the custom cursor's hotspot.
- */
- hotspot: Point) => void): this;
- addListener(event: 'cursor-changed', listener: (event: Event,
- type: string,
- image: NativeImage,
- /**
- * scaling factor for the custom cursor.
- */
- scale: number,
- /**
- * the size of the `image`.
- */
- size: Size,
- /**
- * coordinates of the custom cursor's hotspot.
- */
- hotspot: Point) => void): this;
- removeListener(event: 'cursor-changed', listener: (event: Event,
- type: string,
- image: NativeImage,
- /**
- * scaling factor for the custom cursor.
- */
- scale: number,
- /**
- * the size of the `image`.
- */
- size: Size,
- /**
- * coordinates of the custom cursor's hotspot.
- */
- hotspot: Point) => void): this;
- /**
- * Emitted when `desktopCapturer.getSources()` is called in the renderer process.
- * Calling `event.preventDefault()` will make it return empty sources.
- */
- on(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
- once(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
- addListener(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
- removeListener(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
- /**
- * Emitted when `webContents` is destroyed.
- */
- on(event: 'destroyed', listener: Function): this;
- once(event: 'destroyed', listener: Function): this;
- addListener(event: 'destroyed', listener: Function): this;
- removeListener(event: 'destroyed', listener: Function): this;
- /**
- * Emitted when DevTools is closed.
- */
- on(event: 'devtools-closed', listener: Function): this;
- once(event: 'devtools-closed', listener: Function): this;
- addListener(event: 'devtools-closed', listener: Function): this;
- removeListener(event: 'devtools-closed', listener: Function): this;
- /**
- * Emitted when DevTools is focused / opened.
- */
- on(event: 'devtools-focused', listener: Function): this;
- once(event: 'devtools-focused', listener: Function): this;
- addListener(event: 'devtools-focused', listener: Function): this;
- removeListener(event: 'devtools-focused', listener: Function): this;
- /**
- * Emitted when DevTools is opened.
- */
- on(event: 'devtools-opened', listener: Function): this;
- once(event: 'devtools-opened', listener: Function): this;
- addListener(event: 'devtools-opened', listener: Function): this;
- removeListener(event: 'devtools-opened', listener: Function): this;
- /**
- * Emitted when the devtools window instructs the webContents to reload
- */
- on(event: 'devtools-reload-page', listener: Function): this;
- once(event: 'devtools-reload-page', listener: Function): this;
- addListener(event: 'devtools-reload-page', listener: Function): this;
- removeListener(event: 'devtools-reload-page', listener: Function): this;
- /**
- * Emitted when a `` has been attached to this web contents.
- */
- on(event: 'did-attach-webview', listener: (event: Event,
- /**
- * The guest web contents that is used by the ``.
- */
- webContents: WebContents) => void): this;
- once(event: 'did-attach-webview', listener: (event: Event,
- /**
- * The guest web contents that is used by the ``.
- */
- webContents: WebContents) => void): this;
- addListener(event: 'did-attach-webview', listener: (event: Event,
- /**
- * The guest web contents that is used by the ``.
- */
- webContents: WebContents) => void): this;
- removeListener(event: 'did-attach-webview', listener: (event: Event,
- /**
- * The guest web contents that is used by the ``.
- */
- webContents: WebContents) => void): this;
- /**
- * Emitted when a page's theme color changes. This is usually due to encountering a
- * meta tag:
- */
- on(event: 'did-change-theme-color', listener: (event: Event,
- /**
- * Theme color is in format of '#rrggbb'. It is `null` when no theme color is set.
- */
- color: (string) | (null)) => void): this;
- once(event: 'did-change-theme-color', listener: (event: Event,
- /**
- * Theme color is in format of '#rrggbb'. It is `null` when no theme color is set.
- */
- color: (string) | (null)) => void): this;
- addListener(event: 'did-change-theme-color', listener: (event: Event,
- /**
- * Theme color is in format of '#rrggbb'. It is `null` when no theme color is set.
- */
- color: (string) | (null)) => void): this;
- removeListener(event: 'did-change-theme-color', listener: (event: Event,
- /**
- * Theme color is in format of '#rrggbb'. It is `null` when no theme color is set.
- */
- color: (string) | (null)) => void): this;
- /**
- * This event is like `did-finish-load` but emitted when the load failed. The full
- * list of error codes and their meaning is available here.
- */
- on(event: 'did-fail-load', listener: (event: Event,
- errorCode: number,
- errorDescription: string,
- validatedURL: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- once(event: 'did-fail-load', listener: (event: Event,
- errorCode: number,
- errorDescription: string,
- validatedURL: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- addListener(event: 'did-fail-load', listener: (event: Event,
- errorCode: number,
- errorDescription: string,
- validatedURL: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- removeListener(event: 'did-fail-load', listener: (event: Event,
- errorCode: number,
- errorDescription: string,
- validatedURL: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- /**
- * This event is like `did-fail-load` but emitted when the load was cancelled (e.g.
- * `window.stop()` was invoked).
- */
- on(event: 'did-fail-provisional-load', listener: (event: Event,
- errorCode: number,
- errorDescription: string,
- validatedURL: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- once(event: 'did-fail-provisional-load', listener: (event: Event,
- errorCode: number,
- errorDescription: string,
- validatedURL: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- addListener(event: 'did-fail-provisional-load', listener: (event: Event,
- errorCode: number,
- errorDescription: string,
- validatedURL: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- removeListener(event: 'did-fail-provisional-load', listener: (event: Event,
- errorCode: number,
- errorDescription: string,
- validatedURL: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- /**
- * Emitted when the navigation is done, i.e. the spinner of the tab has stopped
- * spinning, and the `onload` event was dispatched.
- */
- on(event: 'did-finish-load', listener: Function): this;
- once(event: 'did-finish-load', listener: Function): this;
- addListener(event: 'did-finish-load', listener: Function): this;
- removeListener(event: 'did-finish-load', listener: Function): this;
- /**
- * Emitted when a frame has done navigation.
- */
- on(event: 'did-frame-finish-load', listener: (event: Event,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- once(event: 'did-frame-finish-load', listener: (event: Event,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- addListener(event: 'did-frame-finish-load', listener: (event: Event,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- removeListener(event: 'did-frame-finish-load', listener: (event: Event,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- /**
- * Emitted when any frame navigation is done.
- *
- * This event is not emitted for in-page navigations, such as clicking anchor links
- * or updating the `window.location.hash`. Use `did-navigate-in-page` event for
- * this purpose.
- */
- on(event: 'did-frame-navigate', listener: (event: Event,
- url: string,
- /**
- * -1 for non HTTP navigations
- */
- httpResponseCode: number,
- /**
- * empty for non HTTP navigations,
- */
- httpStatusText: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- once(event: 'did-frame-navigate', listener: (event: Event,
- url: string,
- /**
- * -1 for non HTTP navigations
- */
- httpResponseCode: number,
- /**
- * empty for non HTTP navigations,
- */
- httpStatusText: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- addListener(event: 'did-frame-navigate', listener: (event: Event,
- url: string,
- /**
- * -1 for non HTTP navigations
- */
- httpResponseCode: number,
- /**
- * empty for non HTTP navigations,
- */
- httpStatusText: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- removeListener(event: 'did-frame-navigate', listener: (event: Event,
- url: string,
- /**
- * -1 for non HTTP navigations
- */
- httpResponseCode: number,
- /**
- * empty for non HTTP navigations,
- */
- httpStatusText: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- /**
- * Emitted when a main frame navigation is done.
- *
- * This event is not emitted for in-page navigations, such as clicking anchor links
- * or updating the `window.location.hash`. Use `did-navigate-in-page` event for
- * this purpose.
- */
- on(event: 'did-navigate', listener: (event: Event,
- url: string,
- /**
- * -1 for non HTTP navigations
- */
- httpResponseCode: number,
- /**
- * empty for non HTTP navigations
- */
- httpStatusText: string) => void): this;
- once(event: 'did-navigate', listener: (event: Event,
- url: string,
- /**
- * -1 for non HTTP navigations
- */
- httpResponseCode: number,
- /**
- * empty for non HTTP navigations
- */
- httpStatusText: string) => void): this;
- addListener(event: 'did-navigate', listener: (event: Event,
- url: string,
- /**
- * -1 for non HTTP navigations
- */
- httpResponseCode: number,
- /**
- * empty for non HTTP navigations
- */
- httpStatusText: string) => void): this;
- removeListener(event: 'did-navigate', listener: (event: Event,
- url: string,
- /**
- * -1 for non HTTP navigations
- */
- httpResponseCode: number,
- /**
- * empty for non HTTP navigations
- */
- httpStatusText: string) => void): this;
- /**
- * Emitted when an in-page navigation happened in any frame.
- *
- * When in-page navigation happens, the page URL changes but does not cause
- * navigation outside of the page. Examples of this occurring are when anchor links
- * are clicked or when the DOM `hashchange` event is triggered.
- */
- on(event: 'did-navigate-in-page', listener: (event: Event,
- url: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- once(event: 'did-navigate-in-page', listener: (event: Event,
- url: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- addListener(event: 'did-navigate-in-page', listener: (event: Event,
- url: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- removeListener(event: 'did-navigate-in-page', listener: (event: Event,
- url: string,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- /**
- * Emitted after a server side redirect occurs during navigation. For example a
- * 302 redirect.
- *
- * This event can not be prevented, if you want to prevent redirects you should
- * checkout out the `will-redirect` event above.
- */
- on(event: 'did-redirect-navigation', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- once(event: 'did-redirect-navigation', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- addListener(event: 'did-redirect-navigation', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- removeListener(event: 'did-redirect-navigation', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- /**
- * Corresponds to the points in time when the spinner of the tab started spinning.
- */
- on(event: 'did-start-loading', listener: Function): this;
- once(event: 'did-start-loading', listener: Function): this;
- addListener(event: 'did-start-loading', listener: Function): this;
- removeListener(event: 'did-start-loading', listener: Function): this;
- /**
- * Emitted when any frame (including main) starts navigating. `isInplace` will be
- * `true` for in-page navigations.
- */
- on(event: 'did-start-navigation', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- once(event: 'did-start-navigation', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- addListener(event: 'did-start-navigation', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- removeListener(event: 'did-start-navigation', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- /**
- * Corresponds to the points in time when the spinner of the tab stopped spinning.
- */
- on(event: 'did-stop-loading', listener: Function): this;
- once(event: 'did-stop-loading', listener: Function): this;
- addListener(event: 'did-stop-loading', listener: Function): this;
- removeListener(event: 'did-stop-loading', listener: Function): this;
- /**
- * Emitted when the document in the given frame is loaded.
- */
- on(event: 'dom-ready', listener: (event: Event) => void): this;
- once(event: 'dom-ready', listener: (event: Event) => void): this;
- addListener(event: 'dom-ready', listener: (event: Event) => void): this;
- removeListener(event: 'dom-ready', listener: (event: Event) => void): this;
- /**
- * Emitted when the window enters a full-screen state triggered by HTML API.
- */
- on(event: 'enter-html-full-screen', listener: Function): this;
- once(event: 'enter-html-full-screen', listener: Function): this;
- addListener(event: 'enter-html-full-screen', listener: Function): this;
- removeListener(event: 'enter-html-full-screen', listener: Function): this;
- /**
- * Emitted when a result is available for [`webContents.findInPage`] request.
- */
- on(event: 'found-in-page', listener: (event: Event,
- result: Result) => void): this;
- once(event: 'found-in-page', listener: (event: Event,
- result: Result) => void): this;
- addListener(event: 'found-in-page', listener: (event: Event,
- result: Result) => void): this;
- removeListener(event: 'found-in-page', listener: (event: Event,
- result: Result) => void): this;
- /**
- * Emitted when the renderer process sends an asynchronous message via
- * `ipcRenderer.send()`.
- */
- on(event: 'ipc-message', listener: (event: Event,
- channel: string,
- ...args: any[]) => void): this;
- once(event: 'ipc-message', listener: (event: Event,
- channel: string,
- ...args: any[]) => void): this;
- addListener(event: 'ipc-message', listener: (event: Event,
- channel: string,
- ...args: any[]) => void): this;
- removeListener(event: 'ipc-message', listener: (event: Event,
- channel: string,
- ...args: any[]) => void): this;
- /**
- * Emitted when the renderer process sends a synchronous message via
- * `ipcRenderer.sendSync()`.
- */
- on(event: 'ipc-message-sync', listener: (event: Event,
- channel: string,
- ...args: any[]) => void): this;
- once(event: 'ipc-message-sync', listener: (event: Event,
- channel: string,
- ...args: any[]) => void): this;
- addListener(event: 'ipc-message-sync', listener: (event: Event,
- channel: string,
- ...args: any[]) => void): this;
- removeListener(event: 'ipc-message-sync', listener: (event: Event,
- channel: string,
- ...args: any[]) => void): this;
- /**
- * Emitted when the window leaves a full-screen state triggered by HTML API.
- */
- on(event: 'leave-html-full-screen', listener: Function): this;
- once(event: 'leave-html-full-screen', listener: Function): this;
- addListener(event: 'leave-html-full-screen', listener: Function): this;
- removeListener(event: 'leave-html-full-screen', listener: Function): this;
- /**
- * Emitted when `webContents` wants to do basic auth.
- *
-The usage is the same with the `login` event of `app`.
- */
- on(event: 'login', listener: (event: Event,
- request: Request,
- authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- once(event: 'login', listener: (event: Event,
- request: Request,
- authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- addListener(event: 'login', listener: (event: Event,
- request: Request,
- authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- removeListener(event: 'login', listener: (event: Event,
- request: Request,
- authInfo: AuthInfo,
- callback: (username: string, password: string) => void) => void): this;
- /**
- * Emitted when media is paused or done playing.
- */
- on(event: 'media-paused', listener: Function): this;
- once(event: 'media-paused', listener: Function): this;
- addListener(event: 'media-paused', listener: Function): this;
- removeListener(event: 'media-paused', listener: Function): this;
- /**
- * Emitted when media starts playing.
- */
- on(event: 'media-started-playing', listener: Function): this;
- once(event: 'media-started-playing', listener: Function): this;
- addListener(event: 'media-started-playing', listener: Function): this;
- removeListener(event: 'media-started-playing', listener: Function): this;
- /**
- * Emitted when the page requests to open a new window for a `url`. It could be
- * requested by `window.open` or an external link like ``.
- *
- * By default a new `BrowserWindow` will be created for the `url`.
- *
- * Calling `event.preventDefault()` will prevent Electron from automatically
- * creating a new `BrowserWindow`. If you call `event.preventDefault()` and
- * manually create a new `BrowserWindow` then you must set `event.newGuest` to
- * reference the new `BrowserWindow` instance, failing to do so may result in
- * unexpected behavior. For example:
- */
- on(event: 'new-window', listener: (event: Event,
- url: string,
- frameName: string,
- /**
- * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
- * `save-to-disk` and `other`.
- */
- disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
- /**
- * The options which will be used for creating the new `BrowserWindow`.
- */
- options: BrowserWindowConstructorOptions,
- /**
- * The non-standard features (features not handled by Chromium or Electron) given
- * to `window.open()`.
- */
- additionalFeatures: string[],
- /**
- * The referrer that will be passed to the new window. May or may not result in the
- * `Referer` header being sent, depending on the referrer policy.
- */
- referrer: Referrer) => void): this;
- once(event: 'new-window', listener: (event: Event,
- url: string,
- frameName: string,
- /**
- * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
- * `save-to-disk` and `other`.
- */
- disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
- /**
- * The options which will be used for creating the new `BrowserWindow`.
- */
- options: BrowserWindowConstructorOptions,
- /**
- * The non-standard features (features not handled by Chromium or Electron) given
- * to `window.open()`.
- */
- additionalFeatures: string[],
- /**
- * The referrer that will be passed to the new window. May or may not result in the
- * `Referer` header being sent, depending on the referrer policy.
- */
- referrer: Referrer) => void): this;
- addListener(event: 'new-window', listener: (event: Event,
- url: string,
- frameName: string,
- /**
- * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
- * `save-to-disk` and `other`.
- */
- disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
- /**
- * The options which will be used for creating the new `BrowserWindow`.
- */
- options: BrowserWindowConstructorOptions,
- /**
- * The non-standard features (features not handled by Chromium or Electron) given
- * to `window.open()`.
- */
- additionalFeatures: string[],
- /**
- * The referrer that will be passed to the new window. May or may not result in the
- * `Referer` header being sent, depending on the referrer policy.
- */
- referrer: Referrer) => void): this;
- removeListener(event: 'new-window', listener: (event: Event,
- url: string,
- frameName: string,
- /**
- * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
- * `save-to-disk` and `other`.
- */
- disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
- /**
- * The options which will be used for creating the new `BrowserWindow`.
- */
- options: BrowserWindowConstructorOptions,
- /**
- * The non-standard features (features not handled by Chromium or Electron) given
- * to `window.open()`.
- */
- additionalFeatures: string[],
- /**
- * The referrer that will be passed to the new window. May or may not result in the
- * `Referer` header being sent, depending on the referrer policy.
- */
- referrer: Referrer) => void): this;
- /**
- * Emitted when page receives favicon urls.
- */
- on(event: 'page-favicon-updated', listener: (event: Event,
- /**
- * Array of URLs.
- */
- favicons: string[]) => void): this;
- once(event: 'page-favicon-updated', listener: (event: Event,
- /**
- * Array of URLs.
- */
- favicons: string[]) => void): this;
- addListener(event: 'page-favicon-updated', listener: (event: Event,
- /**
- * Array of URLs.
- */
- favicons: string[]) => void): this;
- removeListener(event: 'page-favicon-updated', listener: (event: Event,
- /**
- * Array of URLs.
- */
- favicons: string[]) => void): this;
- /**
- * Fired when page title is set during navigation. `explicitSet` is false when
- * title is synthesized from file url.
- */
- on(event: 'page-title-updated', listener: (event: Event,
- title: string,
- explicitSet: boolean) => void): this;
- once(event: 'page-title-updated', listener: (event: Event,
- title: string,
- explicitSet: boolean) => void): this;
- addListener(event: 'page-title-updated', listener: (event: Event,
- title: string,
- explicitSet: boolean) => void): this;
- removeListener(event: 'page-title-updated', listener: (event: Event,
- title: string,
- explicitSet: boolean) => void): this;
- /**
- * Emitted when a new frame is generated. Only the dirty area is passed in the
- * buffer.
- */
- on(event: 'paint', listener: (event: Event,
- dirtyRect: Rectangle,
- /**
- * The image data of the whole frame.
- */
- image: NativeImage) => void): this;
- once(event: 'paint', listener: (event: Event,
- dirtyRect: Rectangle,
- /**
- * The image data of the whole frame.
- */
- image: NativeImage) => void): this;
- addListener(event: 'paint', listener: (event: Event,
- dirtyRect: Rectangle,
- /**
- * The image data of the whole frame.
- */
- image: NativeImage) => void): this;
- removeListener(event: 'paint', listener: (event: Event,
- dirtyRect: Rectangle,
- /**
- * The image data of the whole frame.
- */
- image: NativeImage) => void): this;
- /**
- * Emitted when a plugin process has crashed.
- */
- on(event: 'plugin-crashed', listener: (event: Event,
- name: string,
- version: string) => void): this;
- once(event: 'plugin-crashed', listener: (event: Event,
- name: string,
- version: string) => void): this;
- addListener(event: 'plugin-crashed', listener: (event: Event,
- name: string,
- version: string) => void): this;
- removeListener(event: 'plugin-crashed', listener: (event: Event,
- name: string,
- version: string) => void): this;
- /**
- * Emitted when the preload script `preloadPath` throws an unhandled exception
- * `error`.
- */
- on(event: 'preload-error', listener: (event: Event,
- preloadPath: string,
- error: Error) => void): this;
- once(event: 'preload-error', listener: (event: Event,
- preloadPath: string,
- error: Error) => void): this;
- addListener(event: 'preload-error', listener: (event: Event,
- preloadPath: string,
- error: Error) => void): this;
- removeListener(event: 'preload-error', listener: (event: Event,
- preloadPath: string,
- error: Error) => void): this;
- /**
- * Emitted when `remote.getBuiltin()` is called in the renderer process. Calling
- * `event.preventDefault()` will prevent the module from being returned. Custom
- * value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-builtin', listener: (event: IpcMainEvent,
- moduleName: string) => void): this;
- once(event: 'remote-get-builtin', listener: (event: IpcMainEvent,
- moduleName: string) => void): this;
- addListener(event: 'remote-get-builtin', listener: (event: IpcMainEvent,
- moduleName: string) => void): this;
- removeListener(event: 'remote-get-builtin', listener: (event: IpcMainEvent,
- moduleName: string) => void): this;
- /**
- * Emitted when `remote.getCurrentWebContents()` is called in the renderer process.
- * Calling `event.preventDefault()` will prevent the object from being returned.
- * Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-current-web-contents', listener: (event: IpcMainEvent) => void): this;
- once(event: 'remote-get-current-web-contents', listener: (event: IpcMainEvent) => void): this;
- addListener(event: 'remote-get-current-web-contents', listener: (event: IpcMainEvent) => void): this;
- removeListener(event: 'remote-get-current-web-contents', listener: (event: IpcMainEvent) => void): this;
- /**
- * Emitted when `remote.getCurrentWindow()` is called in the renderer process.
- * Calling `event.preventDefault()` will prevent the object from being returned.
- * Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-current-window', listener: (event: IpcMainEvent) => void): this;
- once(event: 'remote-get-current-window', listener: (event: IpcMainEvent) => void): this;
- addListener(event: 'remote-get-current-window', listener: (event: IpcMainEvent) => void): this;
- removeListener(event: 'remote-get-current-window', listener: (event: IpcMainEvent) => void): this;
- /**
- * Emitted when `remote.getGlobal()` is called in the renderer process. Calling
- * `event.preventDefault()` will prevent the global from being returned. Custom
- * value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-global', listener: (event: IpcMainEvent,
- globalName: string) => void): this;
- once(event: 'remote-get-global', listener: (event: IpcMainEvent,
- globalName: string) => void): this;
- addListener(event: 'remote-get-global', listener: (event: IpcMainEvent,
- globalName: string) => void): this;
- removeListener(event: 'remote-get-global', listener: (event: IpcMainEvent,
- globalName: string) => void): this;
- /**
- * Emitted when `.getWebContents()` is called in the renderer process.
- * Calling `event.preventDefault()` will prevent the object from being returned.
- * Custom value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-get-guest-web-contents', listener: (event: IpcMainEvent,
- guestWebContents: WebContents) => void): this;
- once(event: 'remote-get-guest-web-contents', listener: (event: IpcMainEvent,
- guestWebContents: WebContents) => void): this;
- addListener(event: 'remote-get-guest-web-contents', listener: (event: IpcMainEvent,
- guestWebContents: WebContents) => void): this;
- removeListener(event: 'remote-get-guest-web-contents', listener: (event: IpcMainEvent,
- guestWebContents: WebContents) => void): this;
- /**
- * Emitted when `remote.require()` is called in the renderer process. Calling
- * `event.preventDefault()` will prevent the module from being returned. Custom
- * value can be returned by setting `event.returnValue`.
- */
- on(event: 'remote-require', listener: (event: IpcMainEvent,
- moduleName: string) => void): this;
- once(event: 'remote-require', listener: (event: IpcMainEvent,
- moduleName: string) => void): this;
- addListener(event: 'remote-require', listener: (event: IpcMainEvent,
- moduleName: string) => void): this;
- removeListener(event: 'remote-require', listener: (event: IpcMainEvent,
- moduleName: string) => void): this;
- /**
- * Emitted when the unresponsive web page becomes responsive again.
- */
- on(event: 'responsive', listener: Function): this;
- once(event: 'responsive', listener: Function): this;
- addListener(event: 'responsive', listener: Function): this;
- removeListener(event: 'responsive', listener: Function): this;
- /**
- * Emitted when bluetooth device needs to be selected on call to
- * `navigator.bluetooth.requestDevice`. To use `navigator.bluetooth` api
- * `webBluetooth` should be enabled. If `event.preventDefault` is not called, first
- * available device will be selected. `callback` should be called with `deviceId`
- * to be selected, passing empty string to `callback` will cancel the request.
- */
- on(event: 'select-bluetooth-device', listener: (event: Event,
- devices: BluetoothDevice[],
- callback: (deviceId: string) => void) => void): this;
- once(event: 'select-bluetooth-device', listener: (event: Event,
- devices: BluetoothDevice[],
- callback: (deviceId: string) => void) => void): this;
- addListener(event: 'select-bluetooth-device', listener: (event: Event,
- devices: BluetoothDevice[],
- callback: (deviceId: string) => void) => void): this;
- removeListener(event: 'select-bluetooth-device', listener: (event: Event,
- devices: BluetoothDevice[],
- callback: (deviceId: string) => void) => void): this;
- /**
- * Emitted when a client certificate is requested.
- *
-The usage is the same with the `select-client-certificate` event of `app`.
- */
- on(event: 'select-client-certificate', listener: (event: Event,
- url: string,
- certificateList: Certificate[],
- callback: (certificate: Certificate) => void) => void): this;
- once(event: 'select-client-certificate', listener: (event: Event,
- url: string,
- certificateList: Certificate[],
- callback: (certificate: Certificate) => void) => void): this;
- addListener(event: 'select-client-certificate', listener: (event: Event,
- url: string,
- certificateList: Certificate[],
- callback: (certificate: Certificate) => void) => void): this;
- removeListener(event: 'select-client-certificate', listener: (event: Event,
- url: string,
- certificateList: Certificate[],
- callback: (certificate: Certificate) => void) => void): this;
- /**
- * Emitted when the web page becomes unresponsive.
- */
- on(event: 'unresponsive', listener: Function): this;
- once(event: 'unresponsive', listener: Function): this;
- addListener(event: 'unresponsive', listener: Function): this;
- removeListener(event: 'unresponsive', listener: Function): this;
- /**
- * Emitted when mouse moves over a link or the keyboard moves the focus to a link.
- */
- on(event: 'update-target-url', listener: (event: Event,
- url: string) => void): this;
- once(event: 'update-target-url', listener: (event: Event,
- url: string) => void): this;
- addListener(event: 'update-target-url', listener: (event: Event,
- url: string) => void): this;
- removeListener(event: 'update-target-url', listener: (event: Event,
- url: string) => void): this;
- /**
- * Emitted when a ``'s web contents is being attached to this web
- * contents. Calling `event.preventDefault()` will destroy the guest page.
- *
- * This event can be used to configure `webPreferences` for the `webContents` of a
- * `` before it's loaded, and provides the ability to set settings that
- * can't be set via `` attributes.
- *
- * **Note:** The specified `preload` script option will be appear as `preloadURL`
- * (not `preload`) in the `webPreferences` object emitted with this event.
- */
- on(event: 'will-attach-webview', listener: (event: Event,
- /**
- * The web preferences that will be used by the guest page. This object can be
- * modified to adjust the preferences for the guest page.
- */
- webPreferences: WebPreferences,
- /**
- * The other `` parameters such as the `src` URL. This object can be
- * modified to adjust the parameters of the guest page.
- */
- params: Record) => void): this;
- once(event: 'will-attach-webview', listener: (event: Event,
- /**
- * The web preferences that will be used by the guest page. This object can be
- * modified to adjust the preferences for the guest page.
- */
- webPreferences: WebPreferences,
- /**
- * The other `` parameters such as the `src` URL. This object can be
- * modified to adjust the parameters of the guest page.
- */
- params: Record) => void): this;
- addListener(event: 'will-attach-webview', listener: (event: Event,
- /**
- * The web preferences that will be used by the guest page. This object can be
- * modified to adjust the preferences for the guest page.
- */
- webPreferences: WebPreferences,
- /**
- * The other `` parameters such as the `src` URL. This object can be
- * modified to adjust the parameters of the guest page.
- */
- params: Record) => void): this;
- removeListener(event: 'will-attach-webview', listener: (event: Event,
- /**
- * The web preferences that will be used by the guest page. This object can be
- * modified to adjust the preferences for the guest page.
- */
- webPreferences: WebPreferences,
- /**
- * The other `` parameters such as the `src` URL. This object can be
- * modified to adjust the parameters of the guest page.
- */
- params: Record) => void): this;
- /**
- * Emitted when a user or the page wants to start navigation. It can happen when
- * the `window.location` object is changed or a user clicks a link in the page.
- *
- * This event will not emit when the navigation is started programmatically with
- * APIs like `webContents.loadURL` and `webContents.back`.
- *
- * It is also not emitted for in-page navigations, such as clicking anchor links or
- * updating the `window.location.hash`. Use `did-navigate-in-page` event for this
- * purpose.
-
-Calling `event.preventDefault()` will prevent the navigation.
- */
- on(event: 'will-navigate', listener: (event: Event,
- url: string) => void): this;
- once(event: 'will-navigate', listener: (event: Event,
- url: string) => void): this;
- addListener(event: 'will-navigate', listener: (event: Event,
- url: string) => void): this;
- removeListener(event: 'will-navigate', listener: (event: Event,
- url: string) => void): this;
- /**
- * Emitted when a `beforeunload` event handler is attempting to cancel a page
- * unload.
- *
- * Calling `event.preventDefault()` will ignore the `beforeunload` event handler
- * and allow the page to be unloaded.
- */
- on(event: 'will-prevent-unload', listener: (event: Event) => void): this;
- once(event: 'will-prevent-unload', listener: (event: Event) => void): this;
- addListener(event: 'will-prevent-unload', listener: (event: Event) => void): this;
- removeListener(event: 'will-prevent-unload', listener: (event: Event) => void): this;
- /**
- * Emitted as a server side redirect occurs during navigation. For example a 302
- * redirect.
- *
- * This event will be emitted after `did-start-navigation` and always before the
- * `did-redirect-navigation` event for the same navigation.
- *
- * Calling `event.preventDefault()` will prevent the navigation (not just the
- * redirect).
- */
- on(event: 'will-redirect', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- once(event: 'will-redirect', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- addListener(event: 'will-redirect', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- removeListener(event: 'will-redirect', listener: (event: Event,
- url: string,
- isInPlace: boolean,
- isMainFrame: boolean,
- frameProcessId: number,
- frameRoutingId: number) => void): this;
- /**
- * Emitted when the user is requesting to change the zoom level using the mouse
- * wheel.
- */
- on(event: 'zoom-changed', listener: (event: Event,
- /**
- * Can be `in` or `out`.
- */
- zoomDirection: ('in' | 'out')) => void): this;
- once(event: 'zoom-changed', listener: (event: Event,
- /**
- * Can be `in` or `out`.
- */
- zoomDirection: ('in' | 'out')) => void): this;
- addListener(event: 'zoom-changed', listener: (event: Event,
- /**
- * Can be `in` or `out`.
- */
- zoomDirection: ('in' | 'out')) => void): this;
- removeListener(event: 'zoom-changed', listener: (event: Event,
- /**
- * Can be `in` or `out`.
- */
- zoomDirection: ('in' | 'out')) => void): this;
- /**
- * Adds the specified path to DevTools workspace. Must be used after DevTools
- * creation:
- */
- addWorkSpace(path: string): void;
- /**
- * Begin subscribing for presentation events and captured frames, the `callback`
- * will be called with `callback(image, dirtyRect)` when there is a presentation
- * event.
- *
- * The `image` is an instance of NativeImage that stores the captured frame.
- *
- * The `dirtyRect` is an object with `x, y, width, height` properties that
- * describes which part of the page was repainted. If `onlyDirty` is set to `true`,
- * `image` will only contain the repainted area. `onlyDirty` defaults to `false`.
- */
- beginFrameSubscription(onlyDirty: boolean, callback: (image: NativeImage, dirtyRect: Rectangle) => void): void;
- /**
- * Begin subscribing for presentation events and captured frames, the `callback`
- * will be called with `callback(image, dirtyRect)` when there is a presentation
- * event.
- *
- * The `image` is an instance of NativeImage that stores the captured frame.
- *
- * The `dirtyRect` is an object with `x, y, width, height` properties that
- * describes which part of the page was repainted. If `onlyDirty` is set to `true`,
- * `image` will only contain the repainted area. `onlyDirty` defaults to `false`.
- */
- beginFrameSubscription(callback: (image: NativeImage, dirtyRect: Rectangle) => void): void;
- /**
- * Whether the browser can go back to previous web page.
- */
- canGoBack(): boolean;
- /**
- * Whether the browser can go forward to next web page.
- */
- canGoForward(): boolean;
- /**
- * Whether the web page can go to `offset`.
- */
- canGoToOffset(offset: number): boolean;
- /**
- * Resolves with a NativeImage
- *
- * Captures a snapshot of the page within `rect`. Omitting `rect` will capture the
- * whole visible page.
- */
- capturePage(rect?: Rectangle): Promise;
- /**
- * Clears the navigation history.
- */
- clearHistory(): void;
- /**
- * Closes the devtools.
- */
- closeDevTools(): void;
- /**
- * Executes the editing command `copy` in web page.
- */
- copy(): void;
- /**
- * Copy the image at the given position to the clipboard.
- */
- copyImageAt(x: number, y: number): void;
- /**
- * Executes the editing command `cut` in web page.
- */
- cut(): void;
- /**
- * Executes the editing command `delete` in web page.
- */
- delete(): void;
- /**
- * Disable device emulation enabled by `webContents.enableDeviceEmulation`.
- */
- disableDeviceEmulation(): void;
- /**
- * Initiates a download of the resource at `url` without navigating. The
- * `will-download` event of `session` will be triggered.
- */
- downloadURL(url: string): void;
- /**
- * Enable device emulation with the given parameters.
- */
- enableDeviceEmulation(parameters: Parameters): void;
- /**
- * End subscribing for frame presentation events.
- */
- endFrameSubscription(): void;
- /**
- * A promise that resolves with the result of the executed code or is rejected if
- * the result of the code is a rejected promise.
- *
- * Evaluates `code` in page.
- *
- * In the browser window some HTML APIs like `requestFullScreen` can only be
- * invoked by a gesture from the user. Setting `userGesture` to `true` will remove
- * this limitation.
-
-Code execution will be suspended until web page stop loading.
- */
- executeJavaScript(code: string, userGesture?: boolean): Promise;
- /**
- * The request id used for the request.
- *
- * Starts a request to find all matches for the `text` in the web page. The result
- * of the request can be obtained by subscribing to `found-in-page` event.
- */
- findInPage(text: string, options?: FindInPageOptions): number;
- /**
- * Focuses the web page.
- */
- focus(): void;
- /**
- * If *offscreen rendering* is enabled returns the current frame rate.
- *
-**Deprecated**
- */
- getFrameRate(): number;
- /**
- * The operating system `pid` of the associated renderer process.
- */
- getOSProcessId(): number;
- /**
- * Get the system printer list.
-
-Returns `PrinterInfo[]`.
- */
- getPrinters(): void;
- /**
- * The Chromium internal `pid` of the associated renderer. Can be compared to the
- * `frameProcessId` passed by frame specific navigation events (e.g.
- * `did-frame-navigate`)
- */
- getProcessId(): number;
- /**
- * The title of the current web page.
- */
- getTitle(): string;
- /**
- * the type of the webContent. Can be `backgroundPage`, `window`, `browserView`,
- * `remote`, `webview` or `offscreen`.
- */
- getType(): ('backgroundPage' | 'window' | 'browserView' | 'remote' | 'webview' | 'offscreen');
- /**
- * The URL of the current web page.
- */
- getURL(): string;
- /**
- * The user agent for this web page.
-
-**Deprecated**
- */
- getUserAgent(): string;
- /**
- * Returns the WebRTC IP Handling Policy.
- */
- getWebRTCIPHandlingPolicy(): string;
- /**
- * the current zoom factor.
-
-**Deprecated**
- */
- getZoomFactor(): number;
- /**
- * the current zoom level.
-
-**Deprecated**
- */
- getZoomLevel(): number;
- /**
- * Makes the browser go back a web page.
- */
- goBack(): void;
- /**
- * Makes the browser go forward a web page.
- */
- goForward(): void;
- /**
- * Navigates browser to the specified absolute web page index.
- */
- goToIndex(index: number): void;
- /**
- * Navigates to the specified offset from the "current entry".
- */
- goToOffset(offset: number): void;
- /**
- * A promise that resolves with a key for the inserted CSS that can later be used
- * to remove the CSS via `contents.removeInsertedCSS(key)`.
- *
- * Injects CSS into the current web page and returns a unique key for the inserted
- * stylesheet.
- */
- insertCSS(css: string, options?: InsertCSSOptions): Promise;
- /**
- * Inserts `text` to the focused element.
- */
- insertText(text: string): Promise;
- /**
- * Starts inspecting element at position (`x`, `y`).
- */
- inspectElement(x: number, y: number): void;
- /**
- * Opens the developer tools for the service worker context.
- */
- inspectServiceWorker(): void;
- /**
- * Opens the developer tools for the shared worker context.
- */
- inspectSharedWorker(): void;
- /**
- * Schedules a full repaint of the window this web contents is in.
- *
- * If *offscreen rendering* is enabled invalidates the frame and generates a new
- * one through the `'paint'` event.
- */
- invalidate(): void;
- /**
- * Whether this page has been muted.
-
-**Deprecated**
- */
- isAudioMuted(): boolean;
- /**
- * Whether the renderer process has crashed.
- */
- isCrashed(): boolean;
- /**
- * Whether audio is currently playing.
- */
- isCurrentlyAudible(): boolean;
- /**
- * Whether the web page is destroyed.
- */
- isDestroyed(): boolean;
- /**
- * Whether the devtools view is focused .
- */
- isDevToolsFocused(): boolean;
- /**
- * Whether the devtools is opened.
- */
- isDevToolsOpened(): boolean;
- /**
- * Whether the web page is focused.
- */
- isFocused(): boolean;
- /**
- * Whether web page is still loading resources.
- */
- isLoading(): boolean;
- /**
- * Whether the main frame (and not just iframes or frames within it) is still
- * loading.
- */
- isLoadingMainFrame(): boolean;
- /**
- * Indicates whether *offscreen rendering* is enabled.
- */
- isOffscreen(): boolean;
- /**
- * If *offscreen rendering* is enabled returns whether it is currently painting.
- */
- isPainting(): boolean;
- /**
- * Whether the web page is waiting for a first-response from the main resource of
- * the page.
- */
- isWaitingForResponse(): boolean;
- /**
- * the promise will resolve when the page has finished loading (see
- * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
- *
- * Loads the given file in the window, `filePath` should be a path to an HTML file
- * relative to the root of your application. For instance an app structure like
- * this:
-
-Would require code like this
- */
- loadFile(filePath: string, options?: LoadFileOptions): Promise;
- /**
- * the promise will resolve when the page has finished loading (see
- * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
- * A noop rejection handler is already attached, which avoids unhandled rejection
- * errors.
- *
- * Loads the `url` in the window. The `url` must contain the protocol prefix, e.g.
- * the `http://` or `file://`. If the load should bypass http cache then use the
- * `pragma` header to achieve it.
- */
- loadURL(url: string, options?: LoadURLOptions): Promise;
- /**
- * Opens the devtools.
- *
- * When `contents` is a `` tag, the `mode` would be `detach` by default,
- * explicitly passing an empty `mode` can force using last used dock state.
- */
- openDevTools(options?: OpenDevToolsOptions): void;
- /**
- * Executes the editing command `paste` in web page.
- */
- paste(): void;
- /**
- * Executes the editing command `pasteAndMatchStyle` in web page.
- */
- pasteAndMatchStyle(): void;
- /**
- * Prints window's web page. When `silent` is set to `true`, Electron will pick the
- * system's default printer if `deviceName` is empty and the default settings for
- * printing.
- *
- * Use `page-break-before: always;` CSS style to force to print to a new page.
- *
-Example usage:
- */
- print(options?: PrintOptions, callback?: (success: boolean, failureReason: 'cancelled' | 'failed') => void): void;
- /**
- * Resolves with the generated PDF data.
- *
- * Prints window's web page as PDF with Chromium's preview printing custom
- * settings.
- *
- * The `landscape` will be ignored if `@page` CSS at-rule is used in the web page.
- *
- * By default, an empty `options` will be regarded as:
- *
- * Use `page-break-before: always;` CSS style to force to print to a new page.
- *
-An example of `webContents.printToPDF`:
- */
- printToPDF(options: PrintToPDFOptions): Promise;
- /**
- * Executes the editing command `redo` in web page.
- */
- redo(): void;
- /**
- * Reloads the current web page.
- */
- reload(): void;
- /**
- * Reloads current page and ignores cache.
- */
- reloadIgnoringCache(): void;
- /**
- * Resolves if the removal was successful.
- *
- * Removes the inserted CSS from the current web page. The stylesheet is identified
- * by its key, which is returned from `contents.insertCSS(css)`.
- */
- removeInsertedCSS(key: string): Promise;
- /**
- * Removes the specified path from DevTools workspace.
- */
- removeWorkSpace(path: string): void;
- /**
- * Executes the editing command `replace` in web page.
- */
- replace(text: string): void;
- /**
- * Executes the editing command `replaceMisspelling` in web page.
- */
- replaceMisspelling(text: string): void;
- /**
- * resolves if the page is saved.
- */
- savePage(fullPath: string, saveType: 'HTMLOnly' | 'HTMLComplete' | 'MHTML'): Promise;
- /**
- * Executes the editing command `selectAll` in web page.
- */
- selectAll(): void;
- /**
- * Send an asynchronous message to renderer process via `channel`, you can also
- * send arbitrary arguments. Arguments will be serialized in JSON internally and
- * hence no functions or prototype chain will be included.
- *
- * The renderer process can handle the message by listening to `channel` with the
- * `ipcRenderer` module.
- *
-An example of sending messages from the main process to the renderer process:
- */
- send(channel: string, ...args: any[]): void;
- /**
- * Sends an input `event` to the page. **Note:** The `BrowserWindow` containing the
- * contents needs to be focused for `sendInputEvent()` to work.
- */
- sendInputEvent(inputEvent: (MouseInputEvent) | (MouseWheelInputEvent) | (KeyboardInputEvent)): void;
- /**
- * Send an asynchronous message to a specific frame in a renderer process via
- * `channel`. Arguments will be serialized as JSON internally and as such no
- * functions or prototype chains will be included.
- *
- * The renderer process can handle the message by listening to `channel` with the
- * `ipcRenderer` module.
- *
- * If you want to get the `frameId` of a given renderer context you should use the
- * `webFrame.routingId` value. E.g.
- *
-You can also read `frameId` from all incoming IPC messages in the main process.
- */
- sendToFrame(frameId: number, channel: string, ...args: any[]): void;
- /**
- * Mute the audio on the current web page.
-
-**Deprecated**
- */
- setAudioMuted(muted: boolean): void;
- /**
- * Controls whether or not this WebContents will throttle animations and timers
- * when the page becomes backgrounded. This also affects the Page Visibility API.
- */
- setBackgroundThrottling(allowed: boolean): void;
- /**
- * Uses the `devToolsWebContents` as the target `WebContents` to show devtools.
- *
- * The `devToolsWebContents` must not have done any navigation, and it should not
- * be used for other purposes after the call.
- *
- * By default Electron manages the devtools by creating an internal `WebContents`
- * with native view, which developers have very limited control of. With the
- * `setDevToolsWebContents` method, developers can use any `WebContents` to show
- * the devtools in it, including `BrowserWindow`, `BrowserView` and ``
- * tag.
- *
- * Note that closing the devtools does not destroy the `devToolsWebContents`, it is
- * caller's responsibility to destroy `devToolsWebContents`.
- *
- * An example of showing devtools in a `` tag:
- *
-An example of showing devtools in a `BrowserWindow`:
- */
- setDevToolsWebContents(devToolsWebContents: WebContents): void;
- /**
- * If *offscreen rendering* is enabled sets the frame rate to the specified number.
- * Only values between 1 and 60 are accepted.
-
-**Deprecated**
- */
- setFrameRate(fps: number): void;
- /**
- * Ignore application menu shortcuts while this web contents is focused.
- *
- * @experimental
- */
- setIgnoreMenuShortcuts(ignore: boolean): void;
- /**
- * Sets the maximum and minimum layout-based (i.e. non-visual) zoom level.
- */
- setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): Promise;
- /**
- * Overrides the user agent for this web page.
-
-**Deprecated**
- */
- setUserAgent(userAgent: string): void;
- /**
- * Sets the maximum and minimum pinch-to-zoom level.
- *
- * > **NOTE**: Visual zoom is disabled by default in Electron. To re-enable it,
- * call:
- */
- setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): Promise;
- /**
- * Setting the WebRTC IP handling policy allows you to control which IPs are
- * exposed via WebRTC. See BrowserLeaks for more details.
- */
- setWebRTCIPHandlingPolicy(policy: 'default' | 'default_public_interface_only' | 'default_public_and_private_interfaces' | 'disable_non_proxied_udp'): void;
- /**
- * Changes the zoom factor to the specified factor. Zoom factor is zoom percent
- * divided by 100, so 300% = 3.0.
-
-**Deprecated**
- */
- setZoomFactor(factor: number): void;
- /**
- * Changes the zoom level to the specified level. The original size is 0 and each
- * increment above or below represents zooming 20% larger or smaller to default
- * limits of 300% and 50% of original size, respectively. The formula for this is
- * `scale := 1.2 ^ level`.
-
-**Deprecated**
- */
- setZoomLevel(level: number): void;
- /**
- * Shows pop-up dictionary that searches the selected word on the page.
- *
- * @platform darwin
- */
- showDefinitionForSelection(): void;
- /**
- * Sets the `item` as dragging item for current drag-drop operation, `file` is the
- * absolute path of the file to be dragged, and `icon` is the image showing under
- * the cursor when dragging.
- */
- startDrag(item: Item): void;
- /**
- * If *offscreen rendering* is enabled and not painting, start painting.
- */
- startPainting(): void;
- /**
- * Stops any pending navigation.
- */
- stop(): void;
- /**
- * Stops any `findInPage` request for the `webContents` with the provided `action`.
- */
- stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): void;
- /**
- * If *offscreen rendering* is enabled and painting, stop painting.
- */
- stopPainting(): void;
- /**
- * Indicates whether the snapshot has been created successfully.
- *
-Takes a V8 heap snapshot and saves it to `filePath`.
- */
- takeHeapSnapshot(filePath: string): Promise;
- /**
- * Toggles the developer tools.
- */
- toggleDevTools(): void;
- /**
- * Executes the editing command `undo` in web page.
- */
- undo(): void;
- /**
- * Executes the editing command `unselect` in web page.
- */
- unselect(): void;
- audioMuted: boolean;
- readonly debugger: Debugger;
- readonly devToolsWebContents: WebContents;
- frameRate: number;
- readonly hostWebContents: WebContents;
- readonly id: number;
- readonly session: Session;
- userAgent: string;
- zoomFactor: number;
- zoomLevel: number;
- }
-
- interface WebFrame extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/web-frame
-
- /**
- * Attempts to free memory that is no longer being used (like images from a
- * previous navigation).
- *
- * Note that blindly calling this method probably makes Electron slower since it
- * will have to refill these emptied caches, you should only call it if an event in
- * your app has occurred that makes you think your page is actually using less
- * memory (i.e. you have navigated from a super heavy page to a mostly empty one,
- * and intend to stay there).
- */
- clearCache(): void;
- /**
- * A promise that resolves with the result of the executed code or is rejected if
- * the result of the code is a rejected promise.
- *
- * Evaluates `code` in page.
- *
- * In the browser window some HTML APIs like `requestFullScreen` can only be
- * invoked by a gesture from the user. Setting `userGesture` to `true` will remove
- * this limitation.
- */
- executeJavaScript(code: string, userGesture?: boolean): Promise;
- /**
- * A promise that resolves with the result of the executed code or is rejected if
- * the result of the code is a rejected promise.
- *
-Works like `executeJavaScript` but evaluates `scripts` in an isolated context.
- */
- executeJavaScriptInIsolatedWorld(worldId: number, scripts: WebSource[], userGesture?: boolean): Promise;
- /**
- * A child of `webFrame` with the supplied `name`, `null` would be returned if
- * there's no such frame or if the frame is not in the current renderer process.
- */
- findFrameByName(name: string): WebFrame;
- /**
- * that has the supplied `routingId`, `null` if not found.
- */
- findFrameByRoutingId(routingId: number): WebFrame;
- /**
- * The frame element in `webFrame's` document selected by `selector`, `null` would
- * be returned if `selector` does not select a frame or if the frame is not in the
- * current renderer process.
- */
- getFrameForSelector(selector: string): WebFrame;
- /**
- * * `images` MemoryUsageDetails
- * * `scripts` MemoryUsageDetails
- * * `cssStyleSheets` MemoryUsageDetails
- * * `xslStyleSheets` MemoryUsageDetails
- * * `fonts` MemoryUsageDetails
- * * `other` MemoryUsageDetails
- *
- * Returns an object describing usage information of Blink's internal memory
- * caches.
-
-This will generate:
- */
- getResourceUsage(): ResourceUsage;
- /**
- * The current zoom factor.
- */
- getZoomFactor(): number;
- /**
- * The current zoom level.
- */
- getZoomLevel(): number;
- /**
- * A key for the inserted CSS that can later be used to remove the CSS via
- * `webFrame.removeInsertedCSS(key)`.
- *
- * Injects CSS into the current web page and returns a unique key for the inserted
- * stylesheet.
- */
- insertCSS(css: string): string;
- /**
- * Inserts `text` to the focused element.
- */
- insertText(text: string): void;
- /**
- * Removes the inserted CSS from the current web page. The stylesheet is identified
- * by its key, which is returned from `webFrame.insertCSS(css)`.
- */
- removeInsertedCSS(key: string): void;
- /**
- * Set the security origin, content security policy and name of the isolated world.
- * Note: If the `csp` is specified, then the `securityOrigin` also has to be
- * specified.
- */
- setIsolatedWorldInfo(worldId: number, info: Info): void;
- /**
- * Sets the maximum and minimum layout-based (i.e. non-visual) zoom level.
- */
- setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
- /**
- * Sets a provider for spell checking in input fields and text areas.
- *
- * The `provider` must be an object that has a `spellCheck` method that accepts an
- * array of individual words for spellchecking. The `spellCheck` function runs
- * asynchronously and calls the `callback` function with an array of misspelt words
- * when complete.
-
-An example of using node-spellchecker as provider:
- */
- setSpellCheckProvider(language: string, provider: Provider): void;
- /**
- * Sets the maximum and minimum pinch-to-zoom level.
- *
- * > **NOTE**: Visual zoom is disabled by default in Electron. To re-enable it,
- * call:
- */
- setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
- /**
- * Changes the zoom factor to the specified factor. Zoom factor is zoom percent
- * divided by 100, so 300% = 3.0.
- */
- setZoomFactor(factor: number): void;
- /**
- * Changes the zoom level to the specified level. The original size is 0 and each
- * increment above or below represents zooming 20% larger or smaller to default
- * limits of 300% and 50% of original size, respectively.
- */
- setZoomLevel(level: number): void;
- /**
- * A `WebFrame | null` representing the first child frame of `webFrame`, the
- * property would be `null` if `webFrame` has no children or if first child is not
- * in the current renderer process.
- *
- */
- readonly firstChild: (WebFrame) | (null);
- /**
- * A `WebFrame | null` representing next sibling frame, the property would be
- * `null` if `webFrame` is the last frame in its parent or if the next sibling is
- * not in the current renderer process.
- *
- */
- readonly nextSibling: (WebFrame) | (null);
- /**
- * A `WebFrame | null` representing the frame which opened `webFrame`, the property
- * would be `null` if there's no opener or opener is not in the current renderer
- * process.
- *
- */
- readonly opener: (WebFrame) | (null);
- /**
- * A `WebFrame | null` representing parent frame of `webFrame`, the property would
- * be `null` if `webFrame` is top or parent is not in the current renderer process.
- *
- */
- readonly parent: (WebFrame) | (null);
- /**
- * An `Integer` representing the unique frame id in the current renderer process.
- * Distinct WebFrame instances that refer to the same underlying frame will have
- * the same `routingId`.
- *
- */
- readonly routingId: number;
- /**
- * A `WebFrame | null` representing top frame in frame hierarchy to which
- * `webFrame` belongs, the property would be `null` if top frame is not in the
- * current renderer process.
- *
- */
- readonly top: (WebFrame) | (null);
- }
-
- class WebRequest {
-
- // Docs: http://electronjs.org/docs/api/web-request
-
- /**
- * The `listener` will be called with `listener(details)` when a server initiated
- * redirect is about to occur.
- */
- onBeforeRedirect(filter: OnBeforeRedirectFilter, listener: ((details: OnBeforeRedirectListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` when a server initiated
- * redirect is about to occur.
- */
- onBeforeRedirect(listener: ((details: OnBeforeRedirectListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details, callback)` when a request
- * is about to occur.
- *
- * The `uploadData` is an array of `UploadData` objects.
- *
- * The `callback` has to be called with an `response` object.
- *
-Some examples of valid `urls`:
- */
- onBeforeRequest(filter: OnBeforeRequestFilter, listener: ((details: OnBeforeRequestListenerDetails, callback: (response: Response) => void) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details, callback)` when a request
- * is about to occur.
- *
- * The `uploadData` is an array of `UploadData` objects.
- *
- * The `callback` has to be called with an `response` object.
- *
-Some examples of valid `urls`:
- */
- onBeforeRequest(listener: ((details: OnBeforeRequestListenerDetails, callback: (response: Response) => void) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details, callback)` before sending
- * an HTTP request, once the request headers are available. This may occur after a
- * TCP connection is made to the server, but before any http data is sent.
- *
-The `callback` has to be called with an `response` object.
- */
- onBeforeSendHeaders(filter: OnBeforeSendHeadersFilter, listener: ((details: OnBeforeSendHeadersListenerDetails, callback: (response: CallbackResponse) => void) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details, callback)` before sending
- * an HTTP request, once the request headers are available. This may occur after a
- * TCP connection is made to the server, but before any http data is sent.
- *
-The `callback` has to be called with an `response` object.
- */
- onBeforeSendHeaders(listener: ((details: OnBeforeSendHeadersListenerDetails, callback: (response: CallbackResponse) => void) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` when a request is
- * completed.
- */
- onCompleted(filter: OnCompletedFilter, listener: ((details: OnCompletedListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` when a request is
- * completed.
- */
- onCompleted(listener: ((details: OnCompletedListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` when an error occurs.
- */
- onErrorOccurred(filter: OnErrorOccurredFilter, listener: ((details: OnErrorOccurredListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` when an error occurs.
- */
- onErrorOccurred(listener: ((details: OnErrorOccurredListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details, callback)` when HTTP
- * response headers of a request have been received.
- *
-The `callback` has to be called with an `response` object.
- */
- onHeadersReceived(filter: OnHeadersReceivedFilter, listener: ((details: OnHeadersReceivedListenerDetails, callback: (response: CallbackResponse) => void) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details, callback)` when HTTP
- * response headers of a request have been received.
- *
-The `callback` has to be called with an `response` object.
- */
- onHeadersReceived(listener: ((details: OnHeadersReceivedListenerDetails, callback: (response: CallbackResponse) => void) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` when first byte of the
- * response body is received. For HTTP requests, this means that the status line
- * and response headers are available.
- */
- onResponseStarted(filter: OnResponseStartedFilter, listener: ((details: OnResponseStartedListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` when first byte of the
- * response body is received. For HTTP requests, this means that the status line
- * and response headers are available.
- */
- onResponseStarted(listener: ((details: OnResponseStartedListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` just before a request is
- * going to be sent to the server, modifications of previous `onBeforeSendHeaders`
- * response are visible by the time this listener is fired.
- */
- onSendHeaders(filter: OnSendHeadersFilter, listener: ((details: OnSendHeadersListenerDetails) => void) | (null)): void;
- /**
- * The `listener` will be called with `listener(details)` just before a request is
- * going to be sent to the server, modifications of previous `onBeforeSendHeaders`
- * response are visible by the time this listener is fired.
- */
- onSendHeaders(listener: ((details: OnSendHeadersListenerDetails) => void) | (null)): void;
- }
-
- interface WebSource {
-
- // Docs: http://electronjs.org/docs/api/structures/web-source
-
- code: string;
- /**
- * Default is 1.
- */
- startLine?: number;
- url?: string;
- }
-
- interface WebviewTag extends HTMLElement {
-
- // Docs: http://electronjs.org/docs/api/webview-tag
-
- /**
- * Fired when a load has committed. This includes navigation within the current
- * document as well as subframe document-level loads, but does not include
- * asynchronous resource loads.
- */
- addEventListener(event: 'load-commit', listener: (event: LoadCommitEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'load-commit', listener: (event: LoadCommitEvent) => void): this;
- /**
- * Fired when the navigation is done, i.e. the spinner of the tab will stop
- * spinning, and the `onload` event is dispatched.
- */
- addEventListener(event: 'did-finish-load', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'did-finish-load', listener: (event: Event) => void): this;
- /**
- * This event is like `did-finish-load`, but fired when the load failed or was
- * cancelled, e.g. `window.stop()` is invoked.
- */
- addEventListener(event: 'did-fail-load', listener: (event: DidFailLoadEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'did-fail-load', listener: (event: DidFailLoadEvent) => void): this;
- /**
- * Fired when a frame has done navigation.
- */
- addEventListener(event: 'did-frame-finish-load', listener: (event: DidFrameFinishLoadEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'did-frame-finish-load', listener: (event: DidFrameFinishLoadEvent) => void): this;
- /**
- * Corresponds to the points in time when the spinner of the tab starts spinning.
- */
- addEventListener(event: 'did-start-loading', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'did-start-loading', listener: (event: Event) => void): this;
- /**
- * Corresponds to the points in time when the spinner of the tab stops spinning.
- */
- addEventListener(event: 'did-stop-loading', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'did-stop-loading', listener: (event: Event) => void): this;
- /**
- * Fired when document in the given frame is loaded.
- */
- addEventListener(event: 'dom-ready', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'dom-ready', listener: (event: Event) => void): this;
- /**
- * Fired when page title is set during navigation. `explicitSet` is false when
- * title is synthesized from file url.
- */
- addEventListener(event: 'page-title-updated', listener: (event: PageTitleUpdatedEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'page-title-updated', listener: (event: PageTitleUpdatedEvent) => void): this;
- /**
- * Fired when page receives favicon urls.
- */
- addEventListener(event: 'page-favicon-updated', listener: (event: PageFaviconUpdatedEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'page-favicon-updated', listener: (event: PageFaviconUpdatedEvent) => void): this;
- /**
- * Fired when page enters fullscreen triggered by HTML API.
- */
- addEventListener(event: 'enter-html-full-screen', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'enter-html-full-screen', listener: (event: Event) => void): this;
- /**
- * Fired when page leaves fullscreen triggered by HTML API.
- */
- addEventListener(event: 'leave-html-full-screen', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'leave-html-full-screen', listener: (event: Event) => void): this;
- /**
- * Fired when the guest window logs a console message.
- *
- * The following example code forwards all log messages to the embedder's console
- * without regard for log level or other properties.
- */
- addEventListener(event: 'console-message', listener: (event: ConsoleMessageEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'console-message', listener: (event: ConsoleMessageEvent) => void): this;
- /**
- * Fired when a result is available for `webview.findInPage` request.
- */
- addEventListener(event: 'found-in-page', listener: (event: FoundInPageEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'found-in-page', listener: (event: FoundInPageEvent) => void): this;
- /**
- * Fired when the guest page attempts to open a new browser window.
- *
-The following example code opens the new url in system's default browser.
- */
- addEventListener(event: 'new-window', listener: (event: NewWindowEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'new-window', listener: (event: NewWindowEvent) => void): this;
- /**
- * Emitted when a user or the page wants to start navigation. It can happen when
- * the `window.location` object is changed or a user clicks a link in the page.
- *
- * This event will not emit when the navigation is started programmatically with
- * APIs like `.loadURL` and `.back`.
- *
- * It is also not emitted during in-page navigation, such as clicking anchor links
- * or updating the `window.location.hash`. Use `did-navigate-in-page` event for
- * this purpose.
-
-Calling `event.preventDefault()` does __NOT__ have any effect.
- */
- addEventListener(event: 'will-navigate', listener: (event: WillNavigateEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'will-navigate', listener: (event: WillNavigateEvent) => void): this;
- /**
- * Emitted when a navigation is done.
- *
- * This event is not emitted for in-page navigations, such as clicking anchor links
- * or updating the `window.location.hash`. Use `did-navigate-in-page` event for
- * this purpose.
- */
- addEventListener(event: 'did-navigate', listener: (event: DidNavigateEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'did-navigate', listener: (event: DidNavigateEvent) => void): this;
- /**
- * Emitted when an in-page navigation happened.
- *
- * When in-page navigation happens, the page URL changes but does not cause
- * navigation outside of the page. Examples of this occurring are when anchor links
- * are clicked or when the DOM `hashchange` event is triggered.
- */
- addEventListener(event: 'did-navigate-in-page', listener: (event: DidNavigateInPageEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'did-navigate-in-page', listener: (event: DidNavigateInPageEvent) => void): this;
- /**
- * Fired when the guest page attempts to close itself.
- *
- * The following example code navigates the `webview` to `about:blank` when the
- * guest attempts to close itself.
- */
- addEventListener(event: 'close', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'close', listener: (event: Event) => void): this;
- /**
- * Fired when the guest page has sent an asynchronous message to embedder page.
- *
- * With `sendToHost` method and `ipc-message` event you can communicate between
- * guest page and embedder page:
- */
- addEventListener(event: 'ipc-message', listener: (event: IpcMessageEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'ipc-message', listener: (event: IpcMessageEvent) => void): this;
- /**
- * Fired when the renderer process is crashed.
- */
- addEventListener(event: 'crashed', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'crashed', listener: (event: Event) => void): this;
- /**
- * Fired when a plugin process is crashed.
- */
- addEventListener(event: 'plugin-crashed', listener: (event: PluginCrashedEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'plugin-crashed', listener: (event: PluginCrashedEvent) => void): this;
- /**
- * Fired when the WebContents is destroyed.
- */
- addEventListener(event: 'destroyed', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'destroyed', listener: (event: Event) => void): this;
- /**
- * Emitted when media starts playing.
- */
- addEventListener(event: 'media-started-playing', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'media-started-playing', listener: (event: Event) => void): this;
- /**
- * Emitted when media is paused or done playing.
- */
- addEventListener(event: 'media-paused', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'media-paused', listener: (event: Event) => void): this;
- /**
- * Emitted when a page's theme color changes. This is usually due to encountering a
- * meta tag:
- */
- addEventListener(event: 'did-change-theme-color', listener: (event: DidChangeThemeColorEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'did-change-theme-color', listener: (event: DidChangeThemeColorEvent) => void): this;
- /**
- * Emitted when mouse moves over a link or the keyboard moves the focus to a link.
- */
- addEventListener(event: 'update-target-url', listener: (event: UpdateTargetUrlEvent) => void, useCapture?: boolean): this;
- removeEventListener(event: 'update-target-url', listener: (event: UpdateTargetUrlEvent) => void): this;
- /**
- * Emitted when DevTools is opened.
- */
- addEventListener(event: 'devtools-opened', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'devtools-opened', listener: (event: Event) => void): this;
- /**
- * Emitted when DevTools is closed.
- */
- addEventListener(event: 'devtools-closed', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'devtools-closed', listener: (event: Event) => void): this;
- /**
- * Emitted when DevTools is focused / opened.
- */
- addEventListener(event: 'devtools-focused', listener: (event: Event) => void, useCapture?: boolean): this;
- removeEventListener(event: 'devtools-focused', listener: (event: Event) => void): this;
- addEventListener(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, useCapture?: boolean): void;
- addEventListener(type: string, listener: EventListenerOrEventListenerObject, useCapture?: boolean): void;
- removeEventListener(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, useCapture?: boolean): void;
- removeEventListener(type: string, listener: EventListenerOrEventListenerObject, useCapture?: boolean): void;
- /**
- * Whether the guest page can go back.
- */
- canGoBack(): boolean;
- /**
- * Whether the guest page can go forward.
- */
- canGoForward(): boolean;
- /**
- * Whether the guest page can go to `offset`.
- */
- canGoToOffset(offset: number): boolean;
- /**
- * Resolves with a NativeImage
- *
- * Captures a snapshot of the page within `rect`. Omitting `rect` will capture the
- * whole visible page.
- */
- capturePage(rect?: Rectangle): Promise;
- /**
- * Clears the navigation history.
- */
- clearHistory(): void;
- /**
- * Closes the DevTools window of guest page.
- */
- closeDevTools(): void;
- /**
- * Executes editing command `copy` in page.
- */
- copy(): void;
- /**
- * Executes editing command `cut` in page.
- */
- cut(): void;
- /**
- * Executes editing command `delete` in page.
- */
- delete(): void;
- /**
- * Initiates a download of the resource at `url` without navigating.
- */
- downloadURL(url: string): void;
- /**
- * A promise that resolves with the result of the executed code or is rejected if
- * the result of the code is a rejected promise.
- *
- * Evaluates `code` in page. If `userGesture` is set, it will create the user
- * gesture context in the page. HTML APIs like `requestFullScreen`, which require
- * user action, can take advantage of this option for automation.
- */
- executeJavaScript(code: string, userGesture?: boolean): Promise;
- /**
- * The request id used for the request.
- *
- * Starts a request to find all matches for the `text` in the web page. The result
- * of the request can be obtained by subscribing to `found-in-page` event.
- */
- findInPage(text: string, options?: FindInPageOptions): number;
- /**
- * The title of guest page.
- */
- getTitle(): string;
- /**
- * The URL of guest page.
- */
- getURL(): string;
- /**
- * The user agent for guest page.
- */
- getUserAgent(): string;
- /**
- * The web contents associated with this `webview`.
- *
- * It depends on the `remote` module, it is therefore not available when this
- * module is disabled.
- */
- getWebContents(): WebContents;
- /**
- * The WebContents ID of this `webview`.
- */
- getWebContentsId(): number;
- /**
- * the current zoom factor.
- */
- getZoomFactor(): number;
- /**
- * the current zoom level.
- */
- getZoomLevel(): number;
- /**
- * Makes the guest page go back.
- */
- goBack(): void;
- /**
- * Makes the guest page go forward.
- */
- goForward(): void;
- /**
- * Navigates to the specified absolute index.
- */
- goToIndex(index: number): void;
- /**
- * Navigates to the specified offset from the "current entry".
- */
- goToOffset(offset: number): void;
- /**
- * A promise that resolves with a key for the inserted CSS that can later be used
- * to remove the CSS via `.removeInsertedCSS(key)`.
- *
- * Injects CSS into the current web page and returns a unique key for the inserted
- * stylesheet.
- */
- insertCSS(css: string): Promise;
- /**
- * Inserts `text` to the focused element.
- */
- insertText(text: string): Promise;
- /**
- * Starts inspecting element at position (`x`, `y`) of guest page.
- */
- inspectElement(x: number, y: number): void;
- /**
- * Opens the DevTools for the service worker context present in the guest page.
- */
- inspectServiceWorker(): void;
- /**
- * Opens the DevTools for the shared worker context present in the guest page.
- */
- inspectSharedWorker(): void;
- /**
- * Whether guest page has been muted.
- */
- isAudioMuted(): boolean;
- /**
- * Whether the renderer process has crashed.
- */
- isCrashed(): boolean;
- /**
- * Whether audio is currently playing.
- */
- isCurrentlyAudible(): boolean;
- /**
- * Whether DevTools window of guest page is focused.
- */
- isDevToolsFocused(): boolean;
- /**
- * Whether guest page has a DevTools window attached.
- */
- isDevToolsOpened(): boolean;
- /**
- * Whether guest page is still loading resources.
- */
- isLoading(): boolean;
- /**
- * Whether the main frame (and not just iframes or frames within it) is still
- * loading.
- */
- isLoadingMainFrame(): boolean;
- /**
- * Whether the guest page is waiting for a first-response for the main resource of
- * the page.
- */
- isWaitingForResponse(): boolean;
- /**
- * The promise will resolve when the page has finished loading (see
- * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
- *
- * Loads the `url` in the webview, the `url` must contain the protocol prefix, e.g.
- * the `http://` or `file://`.
- */
- loadURL(url: string, options?: LoadURLOptions): Promise;
- /**
- * Opens a DevTools window for guest page.
- */
- openDevTools(): void;
- /**
- * Executes editing command `paste` in page.
- */
- paste(): void;
- /**
- * Executes editing command `pasteAndMatchStyle` in page.
- */
- pasteAndMatchStyle(): void;
- /**
- * Prints `webview`'s web page. Same as `webContents.print([options])`.
- */
- print(options?: PrintOptions): Promise;
- /**
- * Resolves with the generated PDF data.
- *
-Prints `webview`'s web page as PDF, Same as `webContents.printToPDF(options)`.
- */
- printToPDF(options: PrintToPDFOptions): Promise;
- /**
- * Executes editing command `redo` in page.
- */
- redo(): void;
- /**
- * Reloads the guest page.
- */
- reload(): void;
- /**
- * Reloads the guest page and ignores cache.
- */
- reloadIgnoringCache(): void;
- /**
- * Resolves if the removal was successful.
- *
- * Removes the inserted CSS from the current web page. The stylesheet is identified
- * by its key, which is returned from `.insertCSS(css)`.
- */
- removeInsertedCSS(key: string): Promise;
- /**
- * Executes editing command `replace` in page.
- */
- replace(text: string): void;
- /**
- * Executes editing command `replaceMisspelling` in page.
- */
- replaceMisspelling(text: string): void;
- /**
- * Executes editing command `selectAll` in page.
- */
- selectAll(): void;
- /**
- * Send an asynchronous message to renderer process via `channel`, you can also
- * send arbitrary arguments. The renderer process can handle the message by
- * listening to the `channel` event with the `ipcRenderer` module.
- *
-See webContents.send for examples.
- */
- send(channel: string, ...args: any[]): Promise;
- /**
- * Sends an input `event` to the page.
- *
-See webContents.sendInputEvent for detailed description of `event` object.
- */
- sendInputEvent(event: (MouseInputEvent) | (MouseWheelInputEvent) | (KeyboardInputEvent)): Promise;
- /**
- * Set guest page muted.
- */
- setAudioMuted(muted: boolean): void;
- /**
- * Sets the maximum and minimum layout-based (i.e. non-visual) zoom level.
- */
- setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): Promise;
- /**
- * Overrides the user agent for the guest page.
- */
- setUserAgent(userAgent: string): void;
- /**
- * Sets the maximum and minimum pinch-to-zoom level.
- */
- setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): Promise;
- /**
- * Changes the zoom factor to the specified factor. Zoom factor is zoom percent
- * divided by 100, so 300% = 3.0.
- */
- setZoomFactor(factor: number): void;
- /**
- * Changes the zoom level to the specified level. The original size is 0 and each
- * increment above or below represents zooming 20% larger or smaller to default
- * limits of 300% and 50% of original size, respectively. The formula for this is
- * `scale := 1.2 ^ level`.
- */
- setZoomLevel(level: number): void;
- /**
- * Shows pop-up dictionary that searches the selected word on the page.
- *
- * @platform darwin
- */
- showDefinitionForSelection(): void;
- /**
- * Stops any pending navigation.
- */
- stop(): void;
- /**
- * Stops any `findInPage` request for the `webview` with the provided `action`.
- */
- stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): void;
- /**
- * Executes editing command `undo` in page.
- */
- undo(): void;
- /**
- * Executes editing command `unselect` in page.
- */
- unselect(): void;
- /**
- * A `Boolean`. When this attribute is present the guest page will be allowed to
- * open new windows. Popups are disabled by default.
- */
- allowpopups: boolean;
- /**
- * A `String` which is a list of strings which specifies the blink features to be
- * disabled separated by `,`. The full list of supported feature strings can be
- * found in the RuntimeEnabledFeatures.json5 file.
- */
- disableblinkfeatures: string;
- /**
- * A `Boolean`. When this attribute is present the guest page will have web
- * security disabled. Web security is enabled by default.
- */
- disablewebsecurity: boolean;
- /**
- * A `String` which is a list of strings which specifies the blink features to be
- * enabled separated by `,`. The full list of supported feature strings can be
- * found in the RuntimeEnabledFeatures.json5 file.
- */
- enableblinkfeatures: string;
- /**
- * A `Boolean`. When this attribute is `false` the guest page in `webview` will not
- * have access to the `remote` module. The remote module is available by default.
- */
- enableremotemodule: boolean;
- /**
- * A `String` that sets the referrer URL for the guest page.
- */
- httpreferrer: string;
- /**
- * A `Boolean`. When this attribute is present the guest page in `webview` will
- * have node integration and can use node APIs like `require` and `process` to
- * access low level system resources. Node integration is disabled by default in
- * the guest page.
- */
- nodeintegration: boolean;
- /**
- * A `Boolean` for the experimental option for enabling NodeJS support in
- * sub-frames such as iframes inside the `webview`. All your preloads will load for
- * every iframe, you can use `process.isMainFrame` to determine if you are in the
- * main frame or not. This option is disabled by default in the guest page.
- */
- nodeintegrationinsubframes: boolean;
- /**
- * A `String` that sets the session used by the page. If `partition` starts with
- * `persist:`, the page will use a persistent session available to all pages in the
- * app with the same `partition`. if there is no `persist:` prefix, the page will
- * use an in-memory session. By assigning the same `partition`, multiple pages can
- * share the same session. If the `partition` is unset then default session of the
- * app will be used.
- *
- * This value can only be modified before the first navigation, since the session
- * of an active renderer process cannot change. Subsequent attempts to modify the
- * value will fail with a DOM exception.
- */
- partition: string;
- /**
- * A `Boolean`. When this attribute is present the guest page in `webview` will be
- * able to use browser plugins. Plugins are disabled by default.
- */
- plugins: boolean;
- /**
- * A `String` that specifies a script that will be loaded before other scripts run
- * in the guest page. The protocol of script's URL must be either `file:` or
- * `asar:`, because it will be loaded by `require` in guest page under the hood.
- *
- * When the guest page doesn't have node integration this script will still have
- * access to all Node APIs, but global objects injected by Node will be deleted
- * after this script has finished executing.
- *
- * **Note:** This option will appear as `preloadURL` (not `preload`) in the
- * `webPreferences` specified to the `will-attach-webview` event.
- */
- preload: string;
- /**
- * A `String` representing the visible URL. Writing to this attribute initiates
- * top-level navigation.
- *
- * Assigning `src` its own value will reload the current page.
- *
- * The `src` attribute can also accept data URLs, such as `data:text/plain,Hello,
- * world!`.
- */
- src: string;
- /**
- * A `String` that sets the user agent for the guest page before the page is
- * navigated to. Once the page is loaded, use the `setUserAgent` method to change
- * the user agent.
- */
- useragent: string;
- /**
- * A `String` which is a comma separated list of strings which specifies the web
- * preferences to be set on the webview. The full list of supported preference
- * strings can be found in BrowserWindow.
- *
- * The string follows the same format as the features string in `window.open`. A
- * name by itself is given a `true` boolean value. A preference can be set to
- * another value by including an `=`, followed by the value. Special values `yes`
- * and `1` are interpreted as `true`, while `no` and `0` are interpreted as
- * `false`.
- */
- webpreferences: string;
- }
-
- interface AboutPanelOptionsOptions {
- /**
- * The app's name.
- */
- applicationName?: string;
- /**
- * The app's version.
- */
- applicationVersion?: string;
- /**
- * Copyright information.
- */
- copyright?: string;
- /**
- * The app's build version number.
- *
- * @platform darwin
- */
- version?: string;
- /**
- * Credit information.
- *
- * @platform darwin
- */
- credits?: string;
- /**
- * List of app authors.
- *
- * @platform linux
- */
- authors?: string[];
- /**
- * The app's website.
- *
- * @platform linux
- */
- website?: string;
- /**
- * Path to the app's icon. Will be shown as 64x64 pixels while retaining aspect
- * ratio.
- *
- * @platform linux
- */
- iconPath?: string;
- }
-
- interface AddRepresentationOptions {
- /**
- * The scale factor to add the image representation for.
- */
- scaleFactor: number;
- /**
- * Defaults to 0. Required if a bitmap buffer is specified as `buffer`.
- */
- width?: number;
- /**
- * Defaults to 0. Required if a bitmap buffer is specified as `buffer`.
- */
- height?: number;
- /**
- * The buffer containing the raw image data.
- */
- buffer?: Buffer;
- /**
- * The data URL containing either a base 64 encoded PNG or JPEG image.
- */
- dataURL?: string;
- }
-
- interface AnimationSettings {
- /**
- * Returns true if rich animations should be rendered. Looks at session type (e.g.
- * remote desktop) and accessibility settings to give guidance for heavy
- * animations.
- */
- shouldRenderRichAnimation: boolean;
- /**
- * Determines on a per-platform basis whether scroll animations (e.g. produced by
- * home/end key) should be enabled.
- */
- scrollAnimationsEnabledBySystem: boolean;
- /**
- * Determines whether the user desires reduced motion based on platform APIs.
- */
- prefersReducedMotion: boolean;
- }
-
- interface AppDetailsOptions {
- /**
- * Window's App User Model ID. It has to be set, otherwise the other options will
- * have no effect.
- */
- appId?: string;
- /**
- * Window's Relaunch Icon.
- */
- appIconPath?: string;
- /**
- * Index of the icon in `appIconPath`. Ignored when `appIconPath` is not set.
- * Default is `0`.
- */
- appIconIndex?: number;
- /**
- * Window's Relaunch Command.
- */
- relaunchCommand?: string;
- /**
- * Window's Relaunch Display Name.
- */
- relaunchDisplayName?: string;
- }
-
- interface AuthInfo {
- isProxy: boolean;
- scheme: string;
- host: string;
- port: number;
- realm: string;
- }
-
- interface AutoResizeOptions {
- /**
- * If `true`, the view's width will grow and shrink together with the window.
- * `false` by default.
- */
- width?: boolean;
- /**
- * If `true`, the view's height will grow and shrink together with the window.
- * `false` by default.
- */
- height?: boolean;
- /**
- * If `true`, the view's x position and width will grow and shrink proportionally
- * with the window. `false` by default.
- */
- horizontal?: boolean;
- /**
- * If `true`, the view's y position and height will grow and shrink proportionally
- * with the window. `false` by default.
- */
- vertical?: boolean;
- }
-
- interface BitmapOptions {
- /**
- * Defaults to 1.0.
- */
- scaleFactor?: number;
- }
-
- interface BlinkMemoryInfo {
- /**
- * Size of all allocated objects in Kilobytes.
- */
- allocated: number;
- /**
- * Size of all marked objects in Kilobytes.
- */
- marked: number;
- /**
- * Total allocated space in Kilobytes.
- */
- total: number;
- }
-
- interface BrowserViewConstructorOptions {
- /**
- * See BrowserWindow.
- */
- webPreferences?: WebPreferences;
- }
-
- interface BrowserWindowConstructorOptions {
- /**
- * Window's width in pixels. Default is `800`.
- */
- width?: number;
- /**
- * Window's height in pixels. Default is `600`.
- */
- height?: number;
- /**
- * (**required** if y is used) Window's left offset from screen. Default is to
- * center the window.
- */
- x?: number;
- /**
- * (**required** if x is used) Window's top offset from screen. Default is to
- * center the window.
- */
- y?: number;
- /**
- * The `width` and `height` would be used as web page's size, which means the
- * actual window's size will include window frame's size and be slightly larger.
- * Default is `false`.
- */
- useContentSize?: boolean;
- /**
- * Show window in the center of the screen.
- */
- center?: boolean;
- /**
- * Window's minimum width. Default is `0`.
- */
- minWidth?: number;
- /**
- * Window's minimum height. Default is `0`.
- */
- minHeight?: number;
- /**
- * Window's maximum width. Default is no limit.
- */
- maxWidth?: number;
- /**
- * Window's maximum height. Default is no limit.
- */
- maxHeight?: number;
- /**
- * Whether window is resizable. Default is `true`.
- */
- resizable?: boolean;
- /**
- * Whether window is movable. This is not implemented on Linux. Default is `true`.
- */
- movable?: boolean;
- /**
- * Whether window is minimizable. This is not implemented on Linux. Default is
- * `true`.
- */
- minimizable?: boolean;
- /**
- * Whether window is maximizable. This is not implemented on Linux. Default is
- * `true`.
- */
- maximizable?: boolean;
- /**
- * Whether window is closable. This is not implemented on Linux. Default is `true`.
- */
- closable?: boolean;
- /**
- * Whether the window can be focused. Default is `true`. On Windows setting
- * `focusable: false` also implies setting `skipTaskbar: true`. On Linux setting
- * `focusable: false` makes the window stop interacting with wm, so the window will
- * always stay on top in all workspaces.
- */
- focusable?: boolean;
- /**
- * Whether the window should always stay on top of other windows. Default is
- * `false`.
- */
- alwaysOnTop?: boolean;
- /**
- * Whether the window should show in fullscreen. When explicitly set to `false` the
- * fullscreen button will be hidden or disabled on macOS. Default is `false`.
- */
- fullscreen?: boolean;
- /**
- * Whether the window can be put into fullscreen mode. On macOS, also whether the
- * maximize/zoom button should toggle full screen mode or maximize window. Default
- * is `true`.
- */
- fullscreenable?: boolean;
- /**
- * Use pre-Lion fullscreen on macOS. Default is `false`.
- */
- simpleFullscreen?: boolean;
- /**
- * Whether to show the window in taskbar. Default is `false`.
- */
- skipTaskbar?: boolean;
- /**
- * The kiosk mode. Default is `false`.
- */
- kiosk?: boolean;
- /**
- * Default window title. Default is `"Electron"`. If the HTML tag `` is
- * defined in the HTML file loaded by `loadURL()`, this property will be ignored.
- */
- title?: string;
- /**
- * The window icon. On Windows it is recommended to use `ICO` icons to get best
- * visual effects, you can also leave it undefined so the executable's icon will be
- * used.
- */
- icon?: (NativeImage) | (string);
- /**
- * Whether window should be shown when created. Default is `true`.
- */
- show?: boolean;
- /**
- * Whether the renderer should be active when `show` is `false` and it has just
- * been created. In order for `document.visibilityState` to work correctly on
- * first load with `show: false` you should set this to `false`. Setting this to
- * `false` will cause the `ready-to-show` event to not fire. Default is `true`.
- */
- paintWhenInitiallyHidden?: boolean;
- /**
- * Specify `false` to create a Frameless Window. Default is `true`.
- */
- frame?: boolean;
- /**
- * Specify parent window. Default is `null`.
- */
- parent?: BrowserWindow;
- /**
- * Whether this is a modal window. This only works when the window is a child
- * window. Default is `false`.
- */
- modal?: boolean;
- /**
- * Whether the web view accepts a single mouse-down event that simultaneously
- * activates the window. Default is `false`.
- */
- acceptFirstMouse?: boolean;
- /**
- * Whether to hide cursor when typing. Default is `false`.
- */
- disableAutoHideCursor?: boolean;
- /**
- * Auto hide the menu bar unless the `Alt` key is pressed. Default is `false`.
- */
- autoHideMenuBar?: boolean;
- /**
- * Enable the window to be resized larger than screen. Only relevant for macOS, as
- * other OSes allow larger-than-screen windows by default. Default is `false`.
- */
- enableLargerThanScreen?: boolean;
- /**
- * Window's background color as a hexadecimal value, like `#66CD00` or `#FFF` or
- * `#80FFFFFF` (alpha in #AARRGGBB format is supported if `transparent` is set to
- * `true`). Default is `#FFF` (white).
- */
- backgroundColor?: string;
- /**
- * Whether window should have a shadow. This is only implemented on macOS. Default
- * is `true`.
- */
- hasShadow?: boolean;
- /**
- * Set the initial opacity of the window, between 0.0 (fully transparent) and 1.0
- * (fully opaque). This is only implemented on Windows and macOS.
- */
- opacity?: number;
- /**
- * Forces using dark theme for the window, only works on some GTK+3 desktop
- * environments. Default is `false`.
- */
- darkTheme?: boolean;
- /**
- * Makes the window transparent. Default is `false`. On Windows, does not work
- * unless the window is frameless.
- */
- transparent?: boolean;
- /**
- * The type of window, default is normal window. See more about this below.
- */
- type?: string;
- /**
- * The style of window title bar. Default is `default`. Possible values are:
- */
- titleBarStyle?: ('default' | 'hidden' | 'hiddenInset' | 'customButtonsOnHover');
- /**
- * Shows the title in the title bar in full screen mode on macOS for all
- * `titleBarStyle` options. Default is `false`.
- */
- fullscreenWindowTitle?: boolean;
- /**
- * Use `WS_THICKFRAME` style for frameless windows on Windows, which adds standard
- * window frame. Setting it to `false` will remove window shadow and window
- * animations. Default is `true`.
- */
- thickFrame?: boolean;
- /**
- * Add a type of vibrancy effect to the window, only on macOS. Can be
- * `appearance-based`, `light`, `dark`, `titlebar`, `selection`, `menu`, `popover`,
- * `sidebar`, `medium-light`, `ultra-dark`, `header`, `sheet`, `window`, `hud`,
- * `fullscreen-ui`, `tooltip`, `content`, `under-window`, or `under-page`. Please
- * note that using `frame: false` in combination with a vibrancy value requires
- * that you use a non-default `titleBarStyle` as well. Also note that
- * `appearance-based`, `light`, `dark`, `medium-light`, and `ultra-dark` have been
- * deprecated and will be removed in an upcoming version of macOS.
- */
- vibrancy?: ('appearance-based' | 'light' | 'dark' | 'titlebar' | 'selection' | 'menu' | 'popover' | 'sidebar' | 'medium-light' | 'ultra-dark' | 'header' | 'sheet' | 'window' | 'hud' | 'fullscreen-ui' | 'tooltip' | 'content' | 'under-window' | 'under-page');
- /**
- * Controls the behavior on macOS when option-clicking the green stoplight button
- * on the toolbar or by clicking the Window > Zoom menu item. If `true`, the window
- * will grow to the preferred width of the web page when zoomed, `false` will cause
- * it to zoom to the width of the screen. This will also affect the behavior when
- * calling `maximize()` directly. Default is `false`.
- */
- zoomToPageWidth?: boolean;
- /**
- * Tab group name, allows opening the window as a native tab on macOS 10.12+.
- * Windows with the same tabbing identifier will be grouped together. This also
- * adds a native new tab button to your window's tab bar and allows your `app` and
- * window to receive the `new-window-for-tab` event.
- */
- tabbingIdentifier?: string;
- /**
- * Settings of web page's features.
- */
- webPreferences?: WebPreferences;
- }
-
- interface CallbackRedirectRequest {
- url: string;
- method?: string;
- session?: (Session) | (null);
- uploadData?: ProtocolResponseUploadData;
- }
-
- interface CallbackResponse {
- cancel?: boolean;
- /**
- * When provided, request will be made with these headers.
- */
- requestHeaders?: Record<string, string>;
- }
-
- interface CertificateTrustDialogOptions {
- /**
- * The certificate to trust/import.
- */
- certificate: Certificate;
- /**
- * The message to display to the user.
- */
- message: string;
- }
-
- interface ClearStorageDataOptions {
- /**
- * Should follow `window.location.origin`’s representation `scheme://host:port`.
- */
- origin?: string;
- /**
- * The types of storages to clear, can contain: `appcache`, `cookies`,
- * `filesystem`, `indexdb`, `localstorage`, `shadercache`, `websql`,
- * `serviceworkers`, `cachestorage`.
- */
- storages?: string[];
- /**
- * The types of quotas to clear, can contain: `temporary`, `persistent`,
- * `syncable`.
- */
- quotas?: string[];
- }
-
- interface ClientRequestConstructorOptions {
- /**
- * The HTTP request method. Defaults to the GET method.
- */
- method?: string;
- /**
- * The request URL. Must be provided in the absolute form with the protocol scheme
- * specified as http or https.
- */
- url?: string;
- /**
- * The `Session` instance with which the request is associated.
- */
- session?: Session;
- /**
- * The name of the `partition` with which the request is associated. Defaults to
- * the empty string. The `session` option prevails on `partition`. Thus if a
- * `session` is explicitly specified, `partition` is ignored.
- */
- partition?: string;
- /**
- * The protocol scheme in the form 'scheme:'. Currently supported values are
- * 'http:' or 'https:'. Defaults to 'http:'.
- */
- protocol?: string;
- /**
- * The server host provided as a concatenation of the hostname and the port number
- * 'hostname:port'.
- */
- host?: string;
- /**
- * The server host name.
- */
- hostname?: string;
- /**
- * The server's listening port number.
- */
- port?: number;
- /**
- * The path part of the request URL.
- */
- path?: string;
- /**
- * The redirect mode for this request. Should be one of `follow`, `error` or
- * `manual`. Defaults to `follow`. When mode is `error`, any redirection will be
- * aborted. When mode is `manual` the redirection will be deferred until
- * `request.followRedirect` is invoked. Listen for the `redirect` event in this
- * mode to get more details about the redirect request.
- */
- redirect?: string;
- }
-
- interface Config {
- /**
- * The URL associated with the PAC file.
- */
- pacScript: string;
- /**
- * Rules indicating which proxies to use.
- */
- proxyRules: string;
- /**
- * Rules indicating which URLs should bypass the proxy settings.
- */
- proxyBypassRules: string;
- }
-
- interface ConsoleMessageEvent extends Event {
- level: number;
- message: string;
- line: number;
- sourceId: string;
- }
-
- interface ContextMenuParams {
- /**
- * x coordinate.
- */
- x: number;
- /**
- * y coordinate.
- */
- y: number;
- /**
- * URL of the link that encloses the node the context menu was invoked on.
- */
- linkURL: string;
- /**
- * Text associated with the link. May be an empty string if the contents of the
- * link are an image.
- */
- linkText: string;
- /**
- * URL of the top level page that the context menu was invoked on.
- */
- pageURL: string;
- /**
- * URL of the subframe that the context menu was invoked on.
- */
- frameURL: string;
- /**
- * Source URL for the element that the context menu was invoked on. Elements with
- * source URLs are images, audio and video.
- */
- srcURL: string;
- /**
- * Type of the node the context menu was invoked on. Can be `none`, `image`,
- * `audio`, `video`, `canvas`, `file` or `plugin`.
- */
- mediaType: ('none' | 'image' | 'audio' | 'video' | 'canvas' | 'file' | 'plugin');
- /**
- * Whether the context menu was invoked on an image which has non-empty contents.
- */
- hasImageContents: boolean;
- /**
- * Whether the context is editable.
- */
- isEditable: boolean;
- /**
- * Text of the selection that the context menu was invoked on.
- */
- selectionText: string;
- /**
- * Title or alt text of the selection that the context was invoked on.
- */
- titleText: string;
- /**
- * The misspelled word under the cursor, if any.
- */
- misspelledWord: string;
- /**
- * The character encoding of the frame on which the menu was invoked.
- */
- frameCharset: string;
- /**
- * If the context menu was invoked on an input field, the type of that field.
- * Possible values are `none`, `plainText`, `password`, `other`.
- */
- inputFieldType: string;
- /**
- * Input source that invoked the context menu. Can be `none`, `mouse`, `keyboard`,
- * `touch` or `touchMenu`.
- */
- menuSourceType: ('none' | 'mouse' | 'keyboard' | 'touch' | 'touchMenu');
- /**
- * The flags for the media element the context menu was invoked on.
- */
- mediaFlags: MediaFlags;
- /**
- * These flags indicate whether the renderer believes it is able to perform the
- * corresponding action.
- */
- editFlags: EditFlags;
- }
-
- interface CrashReporterStartOptions {
- companyName: string;
- /**
- * URL that crash reports will be sent to as POST.
- */
- submitURL: string;
- /**
- * Defaults to `app.name`.
- */
- productName?: string;
- /**
- * Whether crash reports should be sent to the server. Default is `true`.
- */
- uploadToServer?: boolean;
- /**
- * Default is `false`.
- */
- ignoreSystemCrashHandler?: boolean;
- /**
- * An object you can define that will be sent along with the report. Only string
- * properties are sent correctly. Nested objects are not supported. When using
- * Windows, the property names and values must be fewer than 64 characters.
- */
- extra?: Record<string, string>;
- /**
- * Directory to store the crash reports temporarily (only used when the crash
- * reporter is started via `process.crashReporter.start`).
- */
- crashesDirectory?: string;
- }
-
- interface CreateFromBitmapOptions {
- width: number;
- height: number;
- /**
- * Defaults to 1.0.
- */
- scaleFactor?: number;
- }
-
- interface CreateFromBufferOptions {
- /**
- * Required for bitmap buffers.
- */
- width?: number;
- /**
- * Required for bitmap buffers.
- */
- height?: number;
- /**
- * Defaults to 1.0.
- */
- scaleFactor?: number;
- }
-
- interface CreateInterruptedDownloadOptions {
- /**
- * Absolute path of the download.
- */
- path: string;
- /**
- * Complete URL chain for the download.
- */
- urlChain: string[];
- mimeType?: string;
- /**
- * Start range for the download.
- */
- offset: number;
- /**
- * Total length of the download.
- */
- length: number;
- /**
- * Last-Modified header value.
- */
- lastModified: string;
- /**
- * ETag header value.
- */
- eTag: string;
- /**
- * Time when download was started in number of seconds since UNIX epoch.
- */
- startTime?: number;
- }
-
- interface Data {
- text?: string;
- html?: string;
- image?: NativeImage;
- rtf?: string;
- /**
- * The title of the URL at `text`.
- */
- bookmark?: string;
- }
-
- interface Details {
- /**
- * The URL to associate the cookie with. The promise will be rejected if the URL is
- * invalid.
- */
- url: string;
- /**
- * The name of the cookie. Empty by default if omitted.
- */
- name?: string;
- /**
- * The value of the cookie. Empty by default if omitted.
- */
- value?: string;
- /**
- * The domain of the cookie; this will be normalized with a preceding dot so that
- * it's also valid for subdomains. Empty by default if omitted.
- */
- domain?: string;
- /**
- * The path of the cookie. Empty by default if omitted.
- */
- path?: string;
- /**
- * Whether the cookie should be marked as Secure. Defaults to false.
- */
- secure?: boolean;
- /**
- * Whether the cookie should be marked as HTTP only. Defaults to false.
- */
- httpOnly?: boolean;
- /**
- * The expiration date of the cookie as the number of seconds since the UNIX epoch.
- * If omitted then the cookie becomes a session cookie and will not be retained
- * between sessions.
- */
- expirationDate?: number;
- }
-
- interface DidChangeThemeColorEvent extends Event {
- themeColor: string;
- }
-
- interface DidFailLoadEvent extends Event {
- errorCode: number;
- errorDescription: string;
- validatedURL: string;
- isMainFrame: boolean;
- }
-
- interface DidFrameFinishLoadEvent extends Event {
- isMainFrame: boolean;
- }
-
- interface DidNavigateEvent extends Event {
- url: string;
- }
-
- interface DidNavigateInPageEvent extends Event {
- isMainFrame: boolean;
- url: string;
- }
-
- interface DisplayBalloonOptions {
- icon?: (NativeImage) | (string);
- title: string;
- content: string;
- }
-
- interface EnableNetworkEmulationOptions {
- /**
- * Whether to emulate network outage. Defaults to false.
- */
- offline?: boolean;
- /**
- * RTT in ms. Defaults to 0 which will disable latency throttling.
- */
- latency?: number;
- /**
- * Download rate in Bps. Defaults to 0 which will disable download throttling.
- */
- downloadThroughput?: number;
- /**
- * Upload rate in Bps. Defaults to 0 which will disable upload throttling.
- */
- uploadThroughput?: number;
- }
-
- interface FeedURLOptions {
- url: string;
- /**
- * HTTP request headers.
- *
- * @platform darwin
- */
- headers?: Record<string, string>;
- /**
- * Either `json` or `default`, see the Squirrel.Mac README for more information.
- *
- * @platform darwin
- */
- serverType?: string;
- }
-
- interface FileIconOptions {
- size: ('small' | 'normal' | 'large');
- }
-
- interface Filter {
- /**
- * Retrieves cookies which are associated with `url`. Empty implies retrieving
- * cookies of all URLs.
- */
- url?: string;
- /**
- * Filters cookies by name.
- */
- name?: string;
- /**
- * Retrieves cookies whose domains match or are subdomains of `domains`.
- */
- domain?: string;
- /**
- * Retrieves cookies whose path matches `path`.
- */
- path?: string;
- /**
- * Filters cookies by their Secure property.
- */
- secure?: boolean;
- /**
- * Filters out session or persistent cookies.
- */
- session?: boolean;
- }
-
- interface FindInPageOptions {
- /**
- * Whether to search forward or backward, defaults to `true`.
- */
- forward?: boolean;
- /**
- * Whether the operation is first request or a follow up, defaults to `false`.
- */
- findNext?: boolean;
- /**
- * Whether search should be case-sensitive, defaults to `false`.
- */
- matchCase?: boolean;
- /**
- * Whether to look only at the start of words. defaults to `false`.
- */
- wordStart?: boolean;
- /**
- * When combined with `wordStart`, accepts a match in the middle of a word if the
- * match begins with an uppercase letter followed by a lowercase or non-letter.
- * Accepts several other intra-word matches, defaults to `false`.
- */
- medialCapitalAsWordStart?: boolean;
- }
-
- interface FoundInPageEvent extends Event {
- result: FoundInPageResult;
- }
-
- interface FromPartitionOptions {
- /**
- * Whether to enable cache.
- */
- cache: boolean;
- }
-
- interface HandlerRequest {
- url: string;
- headers: Record<string, string>;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface HeapStatistics {
- totalHeapSize: number;
- totalHeapSizeExecutable: number;
- totalPhysicalSize: number;
- totalAvailableSize: number;
- usedHeapSize: number;
- heapSizeLimit: number;
- mallocedMemory: number;
- peakMallocedMemory: number;
- doesZapGarbage: boolean;
- }
-
- interface IgnoreMouseEventsOptions {
- /**
- * If true, forwards mouse move messages to Chromium, enabling mouse related events
- * such as `mouseleave`. Only used when `ignore` is true. If `ignore` is false,
- * forwarding is always disabled regardless of this value.
- *
- * @platform darwin,win32
- */
- forward?: boolean;
- }
-
- interface ImportCertificateOptions {
- /**
- * Path for the pkcs12 file.
- */
- certificate: string;
- /**
- * Passphrase for the certificate.
- */
- password: string;
- }
-
- interface Info {
- /**
- * Security origin for the isolated world.
- */
- securityOrigin?: string;
- /**
- * Content Security Policy for the isolated world.
- */
- csp?: string;
- /**
- * Name for isolated world. Useful in devtools.
- */
- name?: string;
- }
-
- interface Input {
- /**
- * Either `keyUp` or `keyDown`.
- */
- type: string;
- /**
- * Equivalent to KeyboardEvent.key.
- */
- key: string;
- /**
- * Equivalent to KeyboardEvent.code.
- */
- code: string;
- /**
- * Equivalent to KeyboardEvent.repeat.
- */
- isAutoRepeat: boolean;
- /**
- * Equivalent to KeyboardEvent.shiftKey.
- */
- shift: boolean;
- /**
- * Equivalent to KeyboardEvent.controlKey.
- */
- control: boolean;
- /**
- * Equivalent to KeyboardEvent.altKey.
- */
- alt: boolean;
- /**
- * Equivalent to KeyboardEvent.metaKey.
- */
- meta: boolean;
- }
-
- interface InsertCSSOptions {
- /**
- * Can be either 'user' or 'author'; Specifying 'user' enables you to prevent
- * websites from overriding the CSS you insert. Default is 'author'.
- */
- cssOrigin?: string;
- }
-
- interface IpcMessageEvent extends Event {
- channel: string;
- args: any[];
- }
-
- interface Item {
- /**
- * The path(s) to the file(s) being dragged.
- */
- file: (string[]) | (string);
- /**
- * The image must be non-empty on macOS.
- */
- icon: NativeImage;
- }
-
- interface JumpListSettings {
- /**
- * The minimum number of items that will be shown in the Jump List (for a more
- * detailed description of this value see the MSDN docs).
- */
- minItems: number;
- /**
- * Array of `JumpListItem` objects that correspond to items that the user has
- * explicitly removed from custom categories in the Jump List. These items must not
- * be re-added to the Jump List in the **next** call to `app.setJumpList()`,
- * Windows will not display any custom category that contains any of the removed
- * items.
- */
- removedItems: JumpListItem[];
- }
-
- interface LoadCommitEvent extends Event {
- url: string;
- isMainFrame: boolean;
- }
-
- interface LoadFileOptions {
- /**
- * Passed to `url.format()`.
- */
- query?: Record<string, string>;
- /**
- * Passed to `url.format()`.
- */
- search?: string;
- /**
- * Passed to `url.format()`.
- */
- hash?: string;
- }
-
- interface LoadURLOptions {
- /**
- * An HTTP Referrer url.
- */
- httpReferrer?: (string) | (Referrer);
- /**
- * A user agent originating the request.
- */
- userAgent?: string;
- /**
- * Extra headers separated by "\n"
- */
- extraHeaders?: string;
- postData?: (UploadRawData[]) | (UploadFile[]) | (UploadBlob[]);
- /**
- * Base url (with trailing path separator) for files to be loaded by the data url.
- * This is needed only if the specified `url` is a data url and needs to load other
- * files.
- */
- baseURLForDataURL?: string;
- }
-
- interface LoginItemSettings {
- /**
- * `true` if the app is set to open at login.
- */
- openAtLogin: boolean;
- /**
- * `true` if the app is set to open as hidden at login. This setting is not
- * available on MAS builds.
- *
- * @platform darwin
- */
- openAsHidden: boolean;
- /**
- * `true` if the app was opened at login automatically. This setting is not
- * available on MAS builds.
- *
- * @platform darwin
- */
- wasOpenedAtLogin: boolean;
- /**
- * `true` if the app was opened as a hidden login item. This indicates that the app
- * should not open any windows at startup. This setting is not available on MAS
- * builds.
- *
- * @platform darwin
- */
- wasOpenedAsHidden: boolean;
- /**
- * `true` if the app was opened as a login item that should restore the state from
- * the previous session. This indicates that the app should restore the windows
- * that were open the last time the app was closed. This setting is not available
- * on MAS builds.
- *
- * @platform darwin
- */
- restoreState: boolean;
- }
-
- interface LoginItemSettingsOptions {
- /**
- * The executable path to compare against. Defaults to `process.execPath`.
- *
- * @platform win32
- */
- path?: string;
- /**
- * The command-line arguments to compare against. Defaults to an empty array.
- *
- * @platform win32
- */
- args?: string[];
- }
-
- interface MenuItemConstructorOptions {
- /**
- * Will be called with `click(menuItem, browserWindow, event)` when the menu item
- * is clicked.
- */
- click?: (menuItem: MenuItem, browserWindow: BrowserWindow, event: KeyboardEvent) => void;
- /**
- * Can be `undo`, `redo`, `cut`, `copy`, `paste`, `pasteAndMatchStyle`, `delete`,
- * `selectAll`, `reload`, `forceReload`, `toggleDevTools`, `resetZoom`, `zoomIn`,
- * `zoomOut`, `togglefullscreen`, `window`, `minimize`, `close`, `help`, `about`,
- * `services`, `hide`, `hideOthers`, `unhide`, `quit`, `startSpeaking`,
- * `stopSpeaking`, `close`, `minimize`, `zoom`, `front`, `appMenu`, `fileMenu`,
- * `editMenu`, `viewMenu`, `recentDocuments`, `toggleTabBar`, `selectNextTab`,
- * `selectPreviousTab`, `mergeAllWindows`, `clearRecentDocuments`,
- * `moveTabToNewWindow` or `windowMenu` - Define the action of the menu item, when
- * specified the `click` property will be ignored. See roles.
- */
- role?: ('undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'pasteAndMatchStyle' | 'delete' | 'selectAll' | 'reload' | 'forceReload' | 'toggleDevTools' | 'resetZoom' | 'zoomIn' | 'zoomOut' | 'togglefullscreen' | 'window' | 'minimize' | 'close' | 'help' | 'about' | 'services' | 'hide' | 'hideOthers' | 'unhide' | 'quit' | 'startSpeaking' | 'stopSpeaking' | 'close' | 'minimize' | 'zoom' | 'front' | 'appMenu' | 'fileMenu' | 'editMenu' | 'viewMenu' | 'recentDocuments' | 'toggleTabBar' | 'selectNextTab' | 'selectPreviousTab' | 'mergeAllWindows' | 'clearRecentDocuments' | 'moveTabToNewWindow' | 'windowMenu');
- /**
- * Can be `normal`, `separator`, `submenu`, `checkbox` or `radio`.
- */
- type?: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
- label?: string;
- sublabel?: string;
- /**
- * Hover text for this menu item.
- *
- * @platform darwin
- */
- toolTip?: string;
- accelerator?: Accelerator;
- icon?: (NativeImage) | (string);
- /**
- * If false, the menu item will be greyed out and unclickable.
- */
- enabled?: boolean;
- /**
- * default is `true`, and when `false` will prevent the accelerator from triggering
- * the item if the item is not visible`.
- *
- * @platform darwin
- */
- acceleratorWorksWhenHidden?: boolean;
- /**
- * If false, the menu item will be entirely hidden.
- */
- visible?: boolean;
- /**
- * Should only be specified for `checkbox` or `radio` type menu items.
- */
- checked?: boolean;
- /**
- * If false, the accelerator won't be registered with the system, but it will still
- * be displayed. Defaults to true.
- *
- * @platform linux,win32
- */
- registerAccelerator?: boolean;
- /**
- * Should be specified for `submenu` type menu items. If `submenu` is specified,
- * the `type: 'submenu'` can be omitted. If the value is not a `Menu` then it will
- * be automatically converted to one using `Menu.buildFromTemplate`.
- */
- submenu?: (MenuItemConstructorOptions[]) | (Menu);
- /**
- * Unique within a single menu. If defined then it can be used as a reference to
- * this item by the position attribute.
- */
- id?: string;
- /**
- * Inserts this item before the item with the specified label. If the referenced
- * item doesn't exist the item will be inserted at the end of the menu. Also
- * implies that the menu item in question should be placed in the same “group” as
- * the item.
- */
- before?: string[];
- /**
- * Inserts this item after the item with the specified label. If the referenced
- * item doesn't exist the item will be inserted at the end of the menu.
- */
- after?: string[];
- /**
- * Provides a means for a single context menu to declare the placement of their
- * containing group before the containing group of the item with the specified
- * label.
- */
- beforeGroupContaining?: string[];
- /**
- * Provides a means for a single context menu to declare the placement of their
- * containing group after the containing group of the item with the specified
- * label.
- */
- afterGroupContaining?: string[];
- }
-
- interface MessageBoxOptions {
- /**
- * Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"`. On Windows,
- * `"question"` displays the same icon as `"info"`, unless you set an icon using
- * the `"icon"` option. On macOS, both `"warning"` and `"error"` display the same
- * warning icon.
- */
- type?: string;
- /**
- * Array of texts for buttons. On Windows, an empty array will result in one button
- * labeled "OK".
- */
- buttons?: string[];
- /**
- * Index of the button in the buttons array which will be selected by default when
- * the message box opens.
- */
- defaultId?: number;
- /**
- * Title of the message box, some platforms will not show it.
- */
- title?: string;
- /**
- * Content of the message box.
- */
- message: string;
- /**
- * Extra information of the message.
- */
- detail?: string;
- /**
- * If provided, the message box will include a checkbox with the given label.
- */
- checkboxLabel?: string;
- /**
- * Initial checked state of the checkbox. `false` by default.
- */
- checkboxChecked?: boolean;
- icon?: NativeImage;
- /**
- * The index of the button to be used to cancel the dialog, via the `Esc` key. By
- * default this is assigned to the first button with "cancel" or "no" as the label.
- * If no such labeled buttons exist and this option is not set, `0` will be used as
- * the return value.
- */
- cancelId?: number;
- /**
- * On Windows Electron will try to figure out which one of the `buttons` are common
- * buttons (like "Cancel" or "Yes"), and show the others as command links in the
- * dialog. This can make the dialog appear in the style of modern Windows apps. If
- * you don't like this behavior, you can set `noLink` to `true`.
- */
- noLink?: boolean;
- /**
- * Normalize the keyboard access keys across platforms. Default is `false`.
- * Enabling this assumes `&` is used in the button labels for the placement of the
- * keyboard shortcut access key and labels will be converted so they work correctly
- * on each platform, `&` characters are removed on macOS, converted to `_` on
- * Linux, and left untouched on Windows. For example, a button label of `Vie&w`
- * will be converted to `Vie_w` on Linux and `View` on macOS and can be selected
- * via `Alt-W` on Windows and Linux.
- */
- normalizeAccessKeys?: boolean;
- }
-
- interface MessageBoxReturnValue {
- /**
- * The index of the clicked button.
- */
- response: number;
- /**
- * The checked state of the checkbox if `checkboxLabel` was set. Otherwise `false`.
- */
- checkboxChecked: boolean;
- }
-
- interface MessageBoxSyncOptions {
- /**
- * Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"`. On Windows,
- * `"question"` displays the same icon as `"info"`, unless you set an icon using
- * the `"icon"` option. On macOS, both `"warning"` and `"error"` display the same
- * warning icon.
- */
- type?: string;
- /**
- * Array of texts for buttons. On Windows, an empty array will result in one button
- * labeled "OK".
- */
- buttons?: string[];
- /**
- * Index of the button in the buttons array which will be selected by default when
- * the message box opens.
- */
- defaultId?: number;
- /**
- * Title of the message box, some platforms will not show it.
- */
- title?: string;
- /**
- * Content of the message box.
- */
- message: string;
- /**
- * Extra information of the message.
- */
- detail?: string;
- /**
- * If provided, the message box will include a checkbox with the given label.
- */
- checkboxLabel?: string;
- /**
- * Initial checked state of the checkbox. `false` by default.
- */
- checkboxChecked?: boolean;
- icon?: (NativeImage) | (string);
- /**
- * The index of the button to be used to cancel the dialog, via the `Esc` key. By
- * default this is assigned to the first button with "cancel" or "no" as the label.
- * If no such labeled buttons exist and this option is not set, `0` will be used as
- * the return value.
- */
- cancelId?: number;
- /**
- * On Windows Electron will try to figure out which one of the `buttons` are common
- * buttons (like "Cancel" or "Yes"), and show the others as command links in the
- * dialog. This can make the dialog appear in the style of modern Windows apps. If
- * you don't like this behavior, you can set `noLink` to `true`.
- */
- noLink?: boolean;
- /**
- * Normalize the keyboard access keys across platforms. Default is `false`.
- * Enabling this assumes `&` is used in the button labels for the placement of the
- * keyboard shortcut access key and labels will be converted so they work correctly
- * on each platform, `&` characters are removed on macOS, converted to `_` on
- * Linux, and left untouched on Windows. For example, a button label of `Vie&w`
- * will be converted to `Vie_w` on Linux and `View` on macOS and can be selected
- * via `Alt-W` on Windows and Linux.
- */
- normalizeAccessKeys?: boolean;
- }
-
- interface MoveToApplicationsFolderOptions {
- /**
- * A handler for potential conflict in move failure.
- */
- conflictHandler?: (conflictType: 'exists' | 'existsAndRunning') => boolean;
- }
-
- interface NewWindowEvent extends Event {
- url: string;
- frameName: string;
- /**
- * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
- * `save-to-disk` and `other`.
- */
- disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other');
- /**
- * The options which should be used for creating the new `BrowserWindow`.
- */
- options: BrowserWindowConstructorOptions;
- }
-
- interface NotificationConstructorOptions {
- /**
- * A title for the notification, which will be shown at the top of the notification
- * window when it is shown.
- */
- title: string;
- /**
- * A subtitle for the notification, which will be displayed below the title.
- *
- * @platform darwin
- */
- subtitle?: string;
- /**
- * The body text of the notification, which will be displayed below the title or
- * subtitle.
- */
- body: string;
- /**
- * Whether or not to emit an OS notification noise when showing the notification.
- */
- silent?: boolean;
- /**
- * An icon to use in the notification.
- */
- icon?: (string) | (NativeImage);
- /**
- * Whether or not to add an inline reply option to the notification.
- *
- * @platform darwin
- */
- hasReply?: boolean;
- /**
- * The placeholder to write in the inline reply input field.
- *
- * @platform darwin
- */
- replyPlaceholder?: string;
- /**
- * The name of the sound file to play when the notification is shown.
- *
- * @platform darwin
- */
- sound?: string;
- /**
- * Actions to add to the notification. Please read the available actions and
- * limitations in the `NotificationAction` documentation.
- *
- * @platform darwin
- */
- actions?: NotificationAction[];
- /**
- * A custom title for the close button of an alert. An empty string will cause the
- * default localized text to be used.
- *
- * @platform darwin
- */
- closeButtonText?: string;
- }
-
- interface OnBeforeRedirectFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
- interface OnBeforeRedirectListenerDetails {
- id: number;
- url: string;
- method: string;
- webContentsId?: number;
- resourceType: string;
- referrer: string;
- timestamp: number;
- redirectURL: string;
- statusCode: number;
- /**
- * The server IP address that the request was actually sent to.
- */
- ip?: string;
- fromCache: boolean;
- responseHeaders?: Record<string, string>;
- }
-
- interface OnBeforeRequestFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
- interface OnBeforeRequestListenerDetails {
- id: number;
- url: string;
- method: string;
- webContentsId?: number;
- resourceType: string;
- referrer: string;
- timestamp: number;
- uploadData: UploadData[];
- }
-
- interface OnBeforeSendHeadersFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
- interface OnBeforeSendHeadersListenerDetails {
- id: number;
- url: string;
- method: string;
- webContentsId?: number;
- resourceType: string;
- referrer: string;
- timestamp: number;
- requestHeaders: Record<string, string>;
- }
-
- interface OnCompletedFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
- interface OnCompletedListenerDetails {
- id: number;
- url: string;
- method: string;
- webContentsId?: number;
- resourceType: string;
- referrer: string;
- timestamp: number;
- responseHeaders?: Record<string, string>;
- fromCache: boolean;
- statusCode: number;
- statusLine: string;
- }
-
- interface OnErrorOccurredFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
- interface OnErrorOccurredListenerDetails {
- id: number;
- url: string;
- method: string;
- webContentsId?: number;
- resourceType: string;
- referrer: string;
- timestamp: number;
- fromCache: boolean;
- /**
- * The error description.
- */
- error: string;
- }
-
- interface OnHeadersReceivedFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
- interface OnHeadersReceivedListenerDetails {
- id: number;
- url: string;
- method: string;
- webContentsId?: number;
- resourceType: string;
- referrer: string;
- timestamp: number;
- statusLine: string;
- statusCode: number;
- responseHeaders?: Record<string, string>;
- }
-
- interface OnResponseStartedFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
- interface OnResponseStartedListenerDetails {
- id: number;
- url: string;
- method: string;
- webContentsId?: number;
- resourceType: string;
- referrer: string;
- timestamp: number;
- responseHeaders?: Record<string, string>;
- /**
- * Indicates whether the response was fetched from disk cache.
- */
- fromCache: boolean;
- statusCode: number;
- statusLine: string;
- }
-
- interface OnSendHeadersFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
- interface OnSendHeadersListenerDetails {
- id: number;
- url: string;
- method: string;
- webContentsId?: number;
- resourceType: string;
- referrer: string;
- timestamp: number;
- requestHeaders: Record<string, string>;
- }
-
- interface OpenDevToolsOptions {
- /**
- * Opens the devtools with specified dock state, can be `right`, `bottom`,
- * `undocked`, `detach`. Defaults to last used dock state. In `undocked` mode it's
- * possible to dock back. In `detach` mode it's not.
- */
- mode: ('right' | 'bottom' | 'undocked' | 'detach');
- /**
- * Whether to bring the opened devtools window to the foreground. The default is
- * `true`.
- */
- activate?: boolean;
- }
-
- interface OpenDialogOptions {
- title?: string;
- defaultPath?: string;
- /**
- * Custom label for the confirmation button, when left empty the default label will
- * be used.
- */
- buttonLabel?: string;
- filters?: FileFilter[];
- /**
- * Contains which features the dialog should use. The following values are
- * supported:
- */
- properties?: Array<'openFile' | 'openDirectory' | 'multiSelections' | 'showHiddenFiles' | 'createDirectory' | 'promptToCreate' | 'noResolveAliases' | 'treatPackageAsDirectory'>;
- /**
- * Message to display above input boxes.
- *
- * @platform darwin
- */
- message?: string;
- /**
- * Create security scoped bookmarks when packaged for the Mac App Store.
- *
- * @platform darwin,mas
- */
- securityScopedBookmarks?: boolean;
- }
-
- interface OpenDialogReturnValue {
- /**
- * whether or not the dialog was canceled.
- */
- canceled: boolean;
- /**
- * An array of file paths chosen by the user. If the dialog is cancelled this will
- * be an empty array.
- */
- filePaths: string[];
- /**
- * An array matching the `filePaths` array of base64 encoded strings which contains
- * security scoped bookmark data. `securityScopedBookmarks` must be enabled for
- * this to be populated.
- *
- * @platform darwin,mas
- */
- bookmarks?: string[];
- }
-
- interface OpenDialogSyncOptions {
- title?: string;
- defaultPath?: string;
- /**
- * Custom label for the confirmation button, when left empty the default label will
- * be used.
- */
- buttonLabel?: string;
- filters?: FileFilter[];
- /**
- * Contains which features the dialog should use. The following values are
- * supported:
- */
- properties?: Array<'openFile' | 'openDirectory' | 'multiSelections' | 'showHiddenFiles' | 'createDirectory' | 'promptToCreate' | 'noResolveAliases' | 'treatPackageAsDirectory'>;
- /**
- * Message to display above input boxes.
- *
- * @platform darwin
- */
- message?: string;
- /**
- * Create security scoped bookmarks when packaged for the Mac App Store.
- *
- * @platform darwin,mas
- */
- securityScopedBookmarks?: boolean;
- }
-
- interface OpenExternalOptions {
- /**
- * `true` to bring the opened application to the foreground. The default is `true`.
- *
- * @platform darwin
- */
- activate?: boolean;
- /**
- * The working directory.
- *
- * @platform win32
- */
- workingDirectory?: string;
- }
-
- interface PageFaviconUpdatedEvent extends Event {
- /**
- * Array of URLs.
- */
- favicons: string[];
- }
-
- interface PageTitleUpdatedEvent extends Event {
- title: string;
- explicitSet: boolean;
- }
-
- interface Parameters {
- /**
- * Specify the screen type to emulate (default: `desktop`):
- */
- screenPosition: ('desktop' | 'mobile');
- /**
- * Set the emulated screen size (screenPosition == mobile).
- */
- screenSize: Size;
- /**
- * Position the view on the screen (screenPosition == mobile) (default: `{ x: 0, y:
- * 0 }`).
- */
- viewPosition: Point;
- /**
- * Set the device scale factor (if zero defaults to original device scale factor)
- * (default: `0`).
- */
- deviceScaleFactor: number;
- /**
- * Set the emulated view size (empty means no override)
- */
- viewSize: Size;
- /**
- * Scale of emulated view inside available space (not in fit to view mode)
- * (default: `1`).
- */
- scale: number;
- }
-
- interface Payment {
- /**
- * The identifier of the purchased product.
- */
- productIdentifier: string;
- /**
- * The quantity purchased.
- */
- quantity: number;
- }
-
- interface PermissionCheckHandlerHandlerDetails {
- /**
- * The security orign of the `media` check.
- */
- securityOrigin: string;
- /**
- * The type of media access being requested, can be `video`, `audio` or `unknown`
- */
- mediaType: ('video' | 'audio' | 'unknown');
- /**
- * The last URL the requesting frame loaded
- */
- requestingUrl: string;
- /**
- * Whether the frame making the request is the main frame
- */
- isMainFrame: boolean;
- }
-
- interface PermissionRequestHandlerHandlerDetails {
- /**
- * The url of the `openExternal` request.
- */
- externalURL?: string;
- /**
- * The types of media access being requested, elements can be `video` or `audio`
- */
- mediaTypes?: Array<'video' | 'audio'>;
- /**
- * The last URL the requesting frame loaded
- */
- requestingUrl: string;
- /**
- * Whether the frame making the request is the main frame
- */
- isMainFrame: boolean;
- }
-
- interface PluginCrashedEvent extends Event {
- name: string;
- version: string;
- }
-
- interface PopupOptions {
- /**
- * Default is the focused window.
- */
- window?: BrowserWindow;
- /**
- * Default is the current mouse cursor position. Must be declared if `y` is
- * declared.
- */
- x?: number;
- /**
- * Default is the current mouse cursor position. Must be declared if `x` is
- * declared.
- */
- y?: number;
- /**
- * The index of the menu item to be positioned under the mouse cursor at the
- * specified coordinates. Default is -1.
- *
- * @platform darwin
- */
- positioningItem?: number;
- /**
- * Called when menu is closed.
- */
- callback?: () => void;
- }
-
- interface PreconnectOptions {
- /**
- * URL for preconnect. Only the origin is relevant for opening the socket.
- */
- url: string;
- /**
- * number of sockets to preconnect. Must be between 1 and 6. Defaults to 1.
- */
- numSockets?: number;
- }
-
- interface PrintOptions {
- /**
- * Don't ask user for print settings. Default is `false`.
- */
- silent?: boolean;
- /**
- * Prints the background color and image of the web page. Default is `false`.
- */
- printBackground?: boolean;
- /**
- * Set the printer device name to use. Default is `''`.
- */
- deviceName?: string;
- /**
- * Set whether the printed web page will be in color or grayscale. Default is
- * `true`.
- */
- color?: boolean;
- margins?: Margins;
- /**
- * Whether the web page should be printed in landscape mode. Default is `false`.
- */
- landscape?: boolean;
- /**
- * The scale factor of the web page.
- */
- scaleFactor?: number;
- /**
- * The number of pages to print per page sheet.
- */
- pagesPerSheet?: number;
- /**
- * Whether the web page should be collated.
- */
- collate?: boolean;
- /**
- * The number of copies of the web page to print.
- */
- copies?: number;
- /**
- * The page range to print. Should have two keys: `from` and `to`.
- */
- pageRanges?: Record<string, number>;
- /**
- * Set the duplex mode of the printed web page. Can be `simplex`, `shortEdge`, or
- * `longEdge`.
- */
- duplexMode?: ('simplex' | 'shortEdge' | 'longEdge');
- dpi?: Dpi;
- }
-
- interface PrintToPDFOptions {
- /**
- * Specifies the type of margins to use. Uses 0 for default margin, 1 for no
- * margin, and 2 for minimum margin.
- */
- marginsType?: number;
- /**
- * Specify page size of the generated PDF. Can be `A3`, `A4`, `A5`, `Legal`,
- * `Letter`, `Tabloid` or an Object containing `height` and `width` in microns.
- */
- pageSize?: (string) | (Size);
- /**
- * Whether to print CSS backgrounds.
- */
- printBackground?: boolean;
- /**
- * Whether to print selection only.
- */
- printSelectionOnly?: boolean;
- /**
- * `true` for landscape, `false` for portrait.
- */
- landscape?: boolean;
- }
-
- interface Privileges {
- /**
- * Default false.
- */
- standard?: boolean;
- /**
- * Default false.
- */
- secure?: boolean;
- /**
- * Default false.
- */
- bypassCSP?: boolean;
- /**
- * Default false.
- */
- allowServiceWorkers?: boolean;
- /**
- * Default false.
- */
- supportFetchAPI?: boolean;
- /**
- * Default false.
- */
- corsEnabled?: boolean;
- }
-
- interface ProcRequest {
- hostname: string;
- certificate: Certificate;
- /**
- * Verification result from chromium.
- */
- verificationResult: string;
- /**
- * Error code.
- */
- errorCode: number;
- }
-
- interface ProgressBarOptions {
- /**
- * Mode for the progress bar. Can be `none`, `normal`, `indeterminate`, `error` or
- * `paused`.
- *
- * @platform win32
- */
- mode: ('none' | 'normal' | 'indeterminate' | 'error' | 'paused');
- }
-
- interface Provider {
- spellCheck: (words: string[], callback: (misspeltWords: string[]) => void) => void;
- }
-
- interface ReadBookmark {
- title: string;
- url: string;
- }
-
- interface RedirectRequest {
- url: string;
- method?: string;
- session?: (Session) | (null);
- uploadData?: UploadData;
- }
-
- interface RelaunchOptions {
- args?: string[];
- execPath?: string;
- }
-
- interface Request {
- method: string;
- url: string;
- referrer: string;
- }
-
- interface ResizeOptions {
- /**
- * Defaults to the image's width.
- */
- width?: number;
- /**
- * Defaults to the image's height.
- */
- height?: number;
- /**
- * The desired quality of the resize image. Possible values are `good`, `better` or
- * `best`. The default is `best`. These values express a desired quality/speed
- * tradeoff. They are translated into an algorithm-specific method that depends on
- * the capabilities (CPU, GPU) of the underlying platform. It is possible for all
- * three methods to be mapped to the same algorithm on a given platform.
- */
- quality?: string;
- }
-
- interface ResourceUsage {
- images: MemoryUsageDetails;
- scripts: MemoryUsageDetails;
- cssStyleSheets: MemoryUsageDetails;
- xslStyleSheets: MemoryUsageDetails;
- fonts: MemoryUsageDetails;
- other: MemoryUsageDetails;
- }
-
- interface Response {
- cancel?: boolean;
- /**
- * The original request is prevented from being sent or completed and is instead
- * redirected to the given URL.
- */
- redirectURL?: string;
- }
-
- interface Result {
- requestId: number;
- /**
- * Position of the active match.
- */
- activeMatchOrdinal: number;
- /**
- * Number of Matches.
- */
- matches: number;
- /**
- * Coordinates of first match region.
- */
- selectionArea: Rectangle;
- finalUpdate: boolean;
- }
-
- interface SaveDialogOptions {
- title?: string;
- /**
- * Absolute directory path, absolute file path, or file name to use by default.
- */
- defaultPath?: string;
- /**
- * Custom label for the confirmation button, when left empty the default label will
- * be used.
- */
- buttonLabel?: string;
- filters?: FileFilter[];
- /**
- * Message to display above text fields.
- *
- * @platform darwin
- */
- message?: string;
- /**
- * Custom label for the text displayed in front of the filename text field.
- *
- * @platform darwin
- */
- nameFieldLabel?: string;
- /**
- * Show the tags input box, defaults to `true`.
- *
- * @platform darwin
- */
- showsTagField?: boolean;
- /**
- * Create a security scoped bookmark when packaged for the Mac App Store. If this
- * option is enabled and the file doesn't already exist a blank file will be
- * created at the chosen path.
- *
- * @platform darwin,mas
- */
- securityScopedBookmarks?: boolean;
- }
-
- interface SaveDialogReturnValue {
- /**
- * whether or not the dialog was canceled.
- */
- canceled: boolean;
- /**
- * If the dialog is canceled, this will be `undefined`.
- */
- filePath?: string;
- /**
- * Base64 encoded string which contains the security scoped bookmark data for the
- * saved file. `securityScopedBookmarks` must be enabled for this to be present.
- *
- * @platform darwin,mas
- */
- bookmark?: string;
- }
-
- interface SaveDialogSyncOptions {
- title?: string;
- /**
- * Absolute directory path, absolute file path, or file name to use by default.
- */
- defaultPath?: string;
- /**
- * Custom label for the confirmation button, when left empty the default label will
- * be used.
- */
- buttonLabel?: string;
- filters?: FileFilter[];
- /**
- * Message to display above text fields.
- *
- * @platform darwin
- */
- message?: string;
- /**
- * Custom label for the text displayed in front of the filename text field.
- *
- * @platform darwin
- */
- nameFieldLabel?: string;
- /**
- * Show the tags input box, defaults to `true`.
- *
- * @platform darwin
- */
- showsTagField?: boolean;
- /**
- * Create a security scoped bookmark when packaged for the Mac App Store. If this
- * option is enabled and the file doesn't already exist a blank file will be
- * created at the chosen path.
- *
- * @platform darwin,mas
- */
- securityScopedBookmarks?: boolean;
- }
-
- interface Settings {
- /**
- * `true` to open the app at login, `false` to remove the app as a login item.
- * Defaults to `false`.
- */
- openAtLogin?: boolean;
- /**
- * `true` to open the app as hidden. Defaults to `false`. The user can edit this
- * setting from the System Preferences so
- * `app.getLoginItemSettings().wasOpenedAsHidden` should be checked when the app is
- * opened to know the current value. This setting is not available on MAS builds.
- *
- * @platform darwin
- */
- openAsHidden?: boolean;
- /**
- * The executable to launch at login. Defaults to `process.execPath`.
- *
- * @platform win32
- */
- path?: string;
- /**
- * The command-line arguments to pass to the executable. Defaults to an empty
- * array. Take care to wrap paths in quotes.
- *
- * @platform win32
- */
- args?: string[];
- }
-
- interface SourcesOptions {
- /**
- * An array of Strings that lists the types of desktop sources to be captured,
- * available types are `screen` and `window`.
- */
- types: string[];
- /**
- * The size that the media source thumbnail should be scaled to. Default is `150` x
- * `150`. Set width or height to 0 when you do not need the thumbnails. This will
- * save the processing time required for capturing the content of each window and
- * screen.
- */
- thumbnailSize?: Size;
- /**
- * Set to true to enable fetching window icons. The default value is false. When
- * false the appIcon property of the sources return null. Same if a source has the
- * type screen.
- */
- fetchWindowIcons?: boolean;
- }
-
- interface StartLoggingOptions {
- /**
- * What kinds of data should be captured. By default, only metadata about requests
- * will be captured. Setting this to `includeSensitive` will include cookies and
- * authentication data. Setting it to `everything` will include all bytes
- * transferred on sockets. Can be `default`, `includeSensitive` or `everything`.
- */
- captureMode?: ('default' | 'includeSensitive' | 'everything');
- /**
- * When the log grows beyond this size, logging will automatically stop. Defaults
- * to unlimited.
- */
- maxFileSize?: number;
- }
-
- interface SystemMemoryInfo {
- /**
- * The total amount of physical memory in Kilobytes available to the system.
- */
- total: number;
- /**
- * The total amount of memory not being used by applications or disk cache.
- */
- free: number;
- /**
- * The total amount of swap memory in Kilobytes available to the system.
- *
- * @platform win32,linux
- */
- swapTotal: number;
- /**
- * The free amount of swap memory in Kilobytes available to the system.
- *
- * @platform win32,linux
- */
- swapFree: number;
- }
-
- interface ToBitmapOptions {
- /**
- * Defaults to 1.0.
- */
- scaleFactor?: number;
- }
-
- interface ToDataURLOptions {
- /**
- * Defaults to 1.0.
- */
- scaleFactor?: number;
- }
-
- interface ToPNGOptions {
- /**
- * Defaults to 1.0.
- */
- scaleFactor?: number;
- }
-
- interface TouchBarButtonConstructorOptions {
- /**
- * Button text.
- */
- label?: string;
- /**
- * Button background color in hex format, i.e `#ABCDEF`.
- */
- backgroundColor?: string;
- /**
- * Button icon.
- */
- icon?: (NativeImage) | (string);
- /**
- * Can be `left`, `right` or `overlay`.
- */
- iconPosition?: ('left' | 'right' | 'overlay');
- /**
- * Function to call when the button is clicked.
- */
- click?: () => void;
- }
-
- interface TouchBarColorPickerConstructorOptions {
- /**
- * Array of hex color strings to appear as possible colors to select.
- */
- availableColors?: string[];
- /**
- * The selected hex color in the picker, i.e `#ABCDEF`.
- */
- selectedColor?: string;
- /**
- * Function to call when a color is selected.
- */
- change?: (color: string) => void;
- }
-
- interface TouchBarConstructorOptions {
- items?: Array<(TouchBarButton) | (TouchBarColorPicker) | (TouchBarGroup) | (TouchBarLabel) | (TouchBarPopover) | (TouchBarScrubber) | (TouchBarSegmentedControl) | (TouchBarSlider) | (TouchBarSpacer)>;
- escapeItem?: (TouchBarButton) | (TouchBarColorPicker) | (TouchBarGroup) | (TouchBarLabel) | (TouchBarPopover) | (TouchBarScrubber) | (TouchBarSegmentedControl) | (TouchBarSlider) | (TouchBarSpacer) | (null);
- }
-
- interface TouchBarGroupConstructorOptions {
- /**
- * Items to display as a group.
- */
- items: TouchBar;
- }
-
- interface TouchBarLabelConstructorOptions {
- /**
- * Text to display.
- */
- label?: string;
- /**
- * Hex color of text, i.e `#ABCDEF`.
- */
- textColor?: string;
- }
-
- interface TouchBarPopoverConstructorOptions {
- /**
- * Popover button text.
- */
- label?: string;
- /**
- * Popover button icon.
- */
- icon?: NativeImage;
- /**
- * Items to display in the popover.
- */
- items?: TouchBar;
- /**
- * `true` to display a close button on the left of the popover, `false` to not show
- * it. Default is `true`.
- */
- showCloseButton?: boolean;
- }
-
- interface TouchBarScrubberConstructorOptions {
- /**
- * An array of items to place in this scrubber.
- */
- items: ScrubberItem[];
- /**
- * Called when the user taps an item that was not the last tapped item.
- */
- select?: (selectedIndex: number) => void;
- /**
- * Called when the user taps any item.
- */
- highlight?: (highlightedIndex: number) => void;
- /**
- * Selected item style. Defaults to `null`.
- */
- selectedStyle?: string;
- /**
- * Selected overlay item style. Defaults to `null`.
- */
- overlayStyle?: string;
- /**
- * Defaults to `false`.
- */
- showArrowButtons?: boolean;
- /**
- * Defaults to `free`.
- */
- mode?: string;
- /**
- * Defaults to `true`.
- */
- continuous?: boolean;
- }
-
- interface TouchBarSegmentedControlConstructorOptions {
- /**
- * Style of the segments:
- */
- segmentStyle?: ('automatic' | 'rounded' | 'textured-rounded' | 'round-rect' | 'textured-square' | 'capsule' | 'small-square' | 'separated');
- /**
- * The selection mode of the control:
- */
- mode?: ('single' | 'multiple' | 'buttons');
- /**
- * An array of segments to place in this control.
- */
- segments: SegmentedControlSegment[];
- /**
- * The index of the currently selected segment, will update automatically with user
- * interaction. When the mode is multiple it will be the last selected item.
- */
- selectedIndex?: number;
- /**
- * Called when the user selects a new segment.
- */
- change?: (selectedIndex: number, isSelected: boolean) => void;
- }
-
- interface TouchBarSliderConstructorOptions {
- /**
- * Label text.
- */
- label?: string;
- /**
- * Selected value.
- */
- value?: number;
- /**
- * Minimum value.
- */
- minValue?: number;
- /**
- * Maximum value.
- */
- maxValue?: number;
- /**
- * Function to call when the slider is changed.
- */
- change?: (newValue: number) => void;
- }
-
- interface TouchBarSpacerConstructorOptions {
- /**
- * Size of spacer, possible values are:
- */
- size?: ('small' | 'large' | 'flexible');
- }
-
- interface TraceBufferUsageReturnValue {
- value: number;
- percentage: number;
- }
-
- interface UpdateTargetUrlEvent extends Event {
- url: string;
- }
-
- interface UploadProgress {
- /**
- * Whether the request is currently active. If this is false no other properties
- * will be set
- */
- active: boolean;
- /**
- * Whether the upload has started. If this is false both `current` and `total` will
- * be set to 0.
- */
- started: boolean;
- /**
- * The number of bytes that have been uploaded so far
- */
- current: number;
- /**
- * The number of bytes that will be uploaded this request
- */
- total: number;
- }
-
- interface VerifyWidevineCdmOptions {
- session?: Session;
- disableUpdate?: boolean;
- }
-
- interface VisibleOnAllWorkspacesOptions {
- /**
- * Sets whether the window should be visible above fullscreen windows
- *
- * @platform darwin
- */
- visibleOnFullScreen?: boolean;
- }
-
- interface WillNavigateEvent extends Event {
- url: string;
- }
-
- interface Dpi {
- /**
- * The horizontal dpi.
- */
- horizontal?: number;
- /**
- * The vertical dpi.
- */
- vertical?: number;
- }
-
- interface EditFlags {
- /**
- * Whether the renderer believes it can undo.
- */
- canUndo: boolean;
- /**
- * Whether the renderer believes it can redo.
- */
- canRedo: boolean;
- /**
- * Whether the renderer believes it can cut.
- */
- canCut: boolean;
- /**
- * Whether the renderer believes it can copy
- */
- canCopy: boolean;
- /**
- * Whether the renderer believes it can paste.
- */
- canPaste: boolean;
- /**
- * Whether the renderer believes it can delete.
- */
- canDelete: boolean;
- /**
- * Whether the renderer believes it can select all.
- */
- canSelectAll: boolean;
- }
-
- interface FoundInPageResult {
- requestId: number;
- /**
- * Position of the active match.
- */
- activeMatchOrdinal: number;
- /**
- * Number of Matches.
- */
- matches: number;
- /**
- * Coordinates of first match region.
- */
- selectionArea: Rectangle;
- finalUpdate: boolean;
- }
-
- interface Margins {
- /**
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
- */
- marginType?: ('default' | 'none' | 'printableArea' | 'custom');
- /**
- * The top margin of the printed web page, in pixels.
- */
- top?: number;
- /**
- * The bottom margin of the printed web page, in pixels.
- */
- bottom?: number;
- /**
- * The left margin of the printed web page, in pixels.
- */
- left?: number;
- /**
- * The right margin of the printed web page, in pixels.
- */
- right?: number;
- }
-
- interface MediaFlags {
- /**
- * Whether the media element has crashed.
- */
- inError: boolean;
- /**
- * Whether the media element is paused.
- */
- isPaused: boolean;
- /**
- * Whether the media element is muted.
- */
- isMuted: boolean;
- /**
- * Whether the media element has audio.
- */
- hasAudio: boolean;
- /**
- * Whether the media element is looping.
- */
- isLooping: boolean;
- /**
- * Whether the media element's controls are visible.
- */
- isControlsVisible: boolean;
- /**
- * Whether the media element's controls are toggleable.
- */
- canToggleControls: boolean;
- /**
- * Whether the media element can be rotated.
- */
- canRotate: boolean;
- }
-
- interface WebPreferences {
- /**
- * Whether to enable DevTools. If it is set to `false`, can not use
- * `BrowserWindow.webContents.openDevTools()` to open DevTools. Default is `true`.
- */
- devTools?: boolean;
- /**
- * Whether node integration is enabled. Default is `false`.
- */
- nodeIntegration?: boolean;
- /**
- * Whether node integration is enabled in web workers. Default is `false`. More
- * about this can be found in Multithreading.
- */
- nodeIntegrationInWorker?: boolean;
- /**
- * Experimental option for enabling Node.js support in sub-frames such as iframes
- * and child windows. All your preloads will load for every iframe, you can use
- * `process.isMainFrame` to determine if you are in the main frame or not.
- */
- nodeIntegrationInSubFrames?: boolean;
- /**
- * Specifies a script that will be loaded before other scripts run in the page.
- * This script will always have access to node APIs no matter whether node
- * integration is turned on or off. The value should be the absolute file path to
- * the script. When node integration is turned off, the preload script can
- * reintroduce Node global symbols back to the global scope. See example here.
- */
- preload?: string;
- /**
- * If set, this will sandbox the renderer associated with the window, making it
- * compatible with the Chromium OS-level sandbox and disabling the Node.js engine.
- * This is not the same as the `nodeIntegration` option and the APIs available to
- * the preload script are more limited. Read more about the option here. **Note:**
- * This option is currently experimental and may change or be removed in future
- * Electron releases.
- */
- sandbox?: boolean;
- /**
- * Whether to enable the `remote` module. Default is `true`.
- */
- enableRemoteModule?: boolean;
- /**
- * Sets the session used by the page. Instead of passing the Session object
- * directly, you can also choose to use the `partition` option instead, which
- * accepts a partition string. When both `session` and `partition` are provided,
- * `session` will be preferred. Default is the default session.
- */
- session?: Session;
- /**
- * Sets the session used by the page according to the session's partition string.
- * If `partition` starts with `persist:`, the page will use a persistent session
- * available to all pages in the app with the same `partition`. If there is no
- * `persist:` prefix, the page will use an in-memory session. By assigning the same
- * `partition`, multiple pages can share the same session. Default is the default
- * session.
- */
- partition?: string;
- /**
- * When specified, web pages with the same `affinity` will run in the same renderer
- * process. Note that due to reusing the renderer process, certain `webPreferences`
- * options will also be shared between the web pages even when you specified
- * different values for them, including but not limited to `preload`, `sandbox` and
- * `nodeIntegration`. So it is suggested to use exact same `webPreferences` for web
- * pages with the same `affinity`. _This property is experimental_
- */
- affinity?: string;
- /**
- * The default zoom factor of the page, `3.0` represents `300%`. Default is `1.0`.
- */
- zoomFactor?: number;
- /**
- * Enables JavaScript support. Default is `true`.
- */
- javascript?: boolean;
- /**
- * When `false`, it will disable the same-origin policy (usually using testing
- * websites by people), and set `allowRunningInsecureContent` to `true` if this
- * options has not been set by user. Default is `true`.
- */
- webSecurity?: boolean;
- /**
- * Allow an https page to run JavaScript, CSS or plugins from http URLs. Default is
- * `false`.
- */
- allowRunningInsecureContent?: boolean;
- /**
- * Enables image support. Default is `true`.
- */
- images?: boolean;
- /**
- * Make TextArea elements resizable. Default is `true`.
- */
- textAreasAreResizable?: boolean;
- /**
- * Enables WebGL support. Default is `true`.
- */
- webgl?: boolean;
- /**
- * Whether plugins should be enabled. Default is `false`.
- */
- plugins?: boolean;
- /**
- * Enables Chromium's experimental features. Default is `false`.
- */
- experimentalFeatures?: boolean;
- /**
- * Enables scroll bounce (rubber banding) effect on macOS. Default is `false`.
- */
- scrollBounce?: boolean;
- /**
- * A list of feature strings separated by `,`, like `CSSVariables,KeyboardEventKey`
- * to enable. The full list of supported feature strings can be found in the
- * RuntimeEnabledFeatures.json5 file.
- */
- enableBlinkFeatures?: string;
- /**
- * A list of feature strings separated by `,`, like `CSSVariables,KeyboardEventKey`
- * to disable. The full list of supported feature strings can be found in the
- * RuntimeEnabledFeatures.json5 file.
- */
- disableBlinkFeatures?: string;
- /**
- * Sets the default font for the font-family.
- */
- defaultFontFamily?: DefaultFontFamily;
- /**
- * Defaults to `16`.
- */
- defaultFontSize?: number;
- /**
- * Defaults to `13`.
- */
- defaultMonospaceFontSize?: number;
- /**
- * Defaults to `0`.
- */
- minimumFontSize?: number;
- /**
- * Defaults to `ISO-8859-1`.
- */
- defaultEncoding?: string;
- /**
- * Whether to throttle animations and timers when the page becomes background. This
- * also affects the Page Visibility API. Defaults to `true`.
- */
- backgroundThrottling?: boolean;
- /**
- * Whether to enable offscreen rendering for the browser window. Defaults to
- * `false`. See the offscreen rendering tutorial for more details.
- */
- offscreen?: boolean;
- /**
- * Whether to run Electron APIs and the specified `preload` script in a separate
- * JavaScript context. Defaults to `false`. The context that the `preload` script
- * runs in will still have full access to the `document` and `window` globals but
- * it will use its own set of JavaScript builtins (`Array`, `Object`, `JSON`, etc.)
- * and will be isolated from any changes made to the global environment by the
- * loaded page. The Electron API will only be available in the `preload` script and
- * not the loaded page. This option should be used when loading potentially
- * untrusted remote content to ensure the loaded content cannot tamper with the
- * `preload` script and any Electron APIs being used. This option uses the same
- * technique used by Chrome Content Scripts. You can access this context in the dev
- * tools by selecting the 'Electron Isolated Context' entry in the combo box at the
- * top of the Console tab.
- */
- contextIsolation?: boolean;
- /**
- * Whether to use native `window.open()`. Defaults to `false`. Child windows will
- * always have node integration disabled unless `nodeIntegrationInSubFrames` is
- * true. **Note:** This option is currently experimental.
- */
- nativeWindowOpen?: boolean;
- /**
- * Whether to enable the `<webview>` tag. Defaults to `false`. **Note:** The
- * `preload` script configured for the `<webview>` will have node integration
- * enabled when it is executed so you should ensure remote/untrusted content is not
- * able to create a `<webview>` tag with a possibly malicious `preload` script. You
- * can use the `will-attach-webview` event on webContents to strip away the
- * `preload` script and to validate or alter the `<webview>`'s initial settings.
- */
- webviewTag?: boolean;
- /**
- * A list of strings that will be appended to `process.argv` in the renderer
- * process of this app. Useful for passing small bits of data down to renderer
- * process preload scripts.
- */
- additionalArguments?: string[];
- /**
- * Whether to enable browser style consecutive dialog protection. Default is
- * `false`.
- */
- safeDialogs?: boolean;
- /**
- * The message to display when consecutive dialog protection is triggered. If not
- * defined the default message would be used, note that currently the default
- * message is in English and not localized.
- */
- safeDialogsMessage?: string;
- /**
- * Whether dragging and dropping a file or link onto the page causes a navigation.
- * Default is `false`.
- */
- navigateOnDragDrop?: boolean;
- /**
- * Autoplay policy to apply to content in the window, can be
- * `no-user-gesture-required`, `user-gesture-required`,
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
- */
- autoplayPolicy?: ('no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required');
- /**
- * Whether to prevent the window from resizing when entering HTML Fullscreen.
- * Default is `false`.
- */
- disableHtmlFullscreenWindowResize?: boolean;
- }
-
- interface DefaultFontFamily {
- /**
- * Defaults to `Times New Roman`.
- */
- standard?: string;
- /**
- * Defaults to `Times New Roman`.
- */
- serif?: string;
- /**
- * Defaults to `Arial`.
- */
- sansSerif?: string;
- /**
- * Defaults to `Courier New`.
- */
- monospace?: string;
- /**
- * Defaults to `Script`.
- */
- cursive?: string;
- /**
- * Defaults to `Impact`.
- */
- fantasy?: string;
- }
-
-}
-
-declare module 'electron' {
- export = Electron;
-}
-
-interface NodeRequireFunction {
- (moduleName: 'electron'): typeof Electron;
-}
-
-interface File {
- /**
- * The real path to the file on the users filesystem
- */
- path: string;
-}
-
-declare module 'original-fs' {
- import * as fs from 'fs';
- export = fs;
-}
-
-interface Document {
- createElement(tagName: 'webview'): Electron.WebviewTag;
-}
-
-declare namespace NodeJS {
- interface Process extends NodeJS.EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/process
-
- /**
- * Emitted when Electron has loaded its internal initialization script and is
- * beginning to load the web page or the main script.
- *
- * It can be used by the preload script to add removed Node global symbols back to
- * the global scope when node integration is turned off:
- */
- on(event: 'loaded', listener: Function): this;
- once(event: 'loaded', listener: Function): this;
- addListener(event: 'loaded', listener: Function): this;
- removeListener(event: 'loaded', listener: Function): this;
- /**
- * Causes the main thread of the current process crash.
- */
- crash(): void;
- /**
- * * `allocated` Integer - Size of all allocated objects in Kilobytes.
- * * `marked` Integer - Size of all marked objects in Kilobytes.
- * * `total` Integer - Total allocated space in Kilobytes.
- *
- * Returns an object with Blink memory information. It can be useful for debugging
- * rendering / DOM related memory issues. Note that all values are reported in
- * Kilobytes.
- */
- getBlinkMemoryInfo(): Electron.BlinkMemoryInfo;
- getCPUUsage(): Electron.CPUUsage;
- /**
- * The number of milliseconds since epoch, or `null` if the information is
- * unavailable
- *
- * Indicates the creation time of the application. The time is represented as
- * number of milliseconds since epoch. It returns null if it is unable to get the
- * process creation time.
- */
- getCreationTime(): (number) | (null);
- /**
- * * `totalHeapSize` Integer
- * * `totalHeapSizeExecutable` Integer
- * * `totalPhysicalSize` Integer
- * * `totalAvailableSize` Integer
- * * `usedHeapSize` Integer
- * * `heapSizeLimit` Integer
- * * `mallocedMemory` Integer
- * * `peakMallocedMemory` Integer
- * * `doesZapGarbage` Boolean
- *
- * Returns an object with V8 heap statistics. Note that all statistics are reported
- * in Kilobytes.
- */
- getHeapStatistics(): Electron.HeapStatistics;
- getIOCounters(): Electron.IOCounters;
- /**
- * Resolves with a ProcessMemoryInfo
- *
- * Returns an object giving memory usage statistics about the current process. Note
- * that all statistics are reported in Kilobytes. This api should be called after
- * app ready.
- *
- * Chromium does not provide `residentSet` value for macOS. This is because macOS
- * performs in-memory compression of pages that haven't been recently used. As a
- * result the resident set size value is not what one would expect. `private`
- * memory is more representative of the actual pre-compression memory usage of the
- * process on macOS.
- */
- getProcessMemoryInfo(): Promise<Electron.ProcessMemoryInfo>;
- /**
- * * `total` Integer - The total amount of physical memory in Kilobytes available
- * to the system.
- * * `free` Integer - The total amount of memory not being used by applications or
- * disk cache.
- * * `swapTotal` Integer _Windows_ _Linux_ - The total amount of swap memory in
- * Kilobytes available to the system.
- * * `swapFree` Integer _Windows_ _Linux_ - The free amount of swap memory in
- * Kilobytes available to the system.
- *
- * Returns an object giving memory usage statistics about the entire system. Note
- * that all statistics are reported in Kilobytes.
- */
- getSystemMemoryInfo(): Electron.SystemMemoryInfo;
- /**
- * The version of the host operating system.
- *
- * Examples:
- *
- * * `macOS` -> `10.13.6`
- * * `Windows` -> `10.0.17763`
- * * `Linux` -> `4.15.0-45-generic`
- *
- * **Note:** It returns the actual operating system version instead of kernel
- * version on macOS unlike `os.release()`.
- */
- getSystemVersion(): ('macOS' | 'Windows' | 'Linux');
- /**
- * Causes the main thread of the current process hang.
- */
- hang(): void;
- /**
- * Sets the file descriptor soft limit to `maxDescriptors` or the OS hard limit,
- * whichever is lower for the current process.
- *
- * @platform darwin,linux
- */
- setFdLimit(maxDescriptors: number): void;
- /**
- * Indicates whether the snapshot has been created successfully.
- *
-Takes a V8 heap snapshot and saves it to `filePath`.
- */
- takeHeapSnapshot(filePath: string): boolean;
- /**
- * A `String` representing Chrome's version string.
- *
- */
- readonly chrome: string;
- /**
- * A `Boolean`. When app is started by being passed as parameter to the default
- * app, this property is `true` in the main process, otherwise it is `undefined`.
- *
- */
- readonly defaultApp: boolean;
- /**
- * A `String` representing Electron's version string.
- *
- */
- readonly electron: string;
- /**
- * A `Boolean` that controls whether or not deprecation warnings are printed to
- * `stderr` when formerly callback-based APIs converted to Promises are invoked
- * using callbacks. Setting this to `true` will enable deprecation warnings.
- */
- enablePromiseAPIs: boolean;
- /**
- * A `Boolean`, `true` when the current renderer context is the "main" renderer
- * frame. If you want the ID of the current frame you should use
- * `webFrame.routingId`.
- *
- */
- readonly isMainFrame: boolean;
- /**
- * A `Boolean`. For Mac App Store build, this property is `true`, for other builds
- * it is `undefined`.
- *
- */
- readonly mas: boolean;
- /**
- * A `Boolean` that controls ASAR support inside your application. Setting this to
- * `true` will disable the support for `asar` archives in Node's built-in modules.
- */
- noAsar: boolean;
- /**
- * A `Boolean` that controls whether or not deprecation warnings are printed to
- * `stderr`. Setting this to `true` will silence deprecation warnings. This
- * property is used instead of the `--no-deprecation` command line flag.
- */
- noDeprecation: boolean;
- /**
- * A `String` representing the path to the resources directory.
- *
- */
- readonly resourcesPath: string;
- /**
- * A `Boolean`. When the renderer process is sandboxed, this property is `true`,
- * otherwise it is `undefined`.
- *
- */
- readonly sandboxed: boolean;
- /**
- * A `Boolean` that controls whether or not deprecation warnings will be thrown as
- * exceptions. Setting this to `true` will throw errors for deprecations. This
- * property is used instead of the `--throw-deprecation` command line flag.
- */
- throwDeprecation: boolean;
- /**
- * A `Boolean` that controls whether or not deprecations printed to `stderr`
- * include their stack trace. Setting this to `true` will print stack traces for
- * deprecations. This property is instead of the `--trace-deprecation` command line
- * flag.
- */
- traceDeprecation: boolean;
- /**
- * A `Boolean` that controls whether or not process warnings printed to `stderr`
- * include their stack trace. Setting this to `true` will print stack traces for
- * process warnings (including deprecations). This property is instead of the
- * `--trace-warnings` command line flag.
- */
- traceProcessWarnings: boolean;
- /**
- * A `String` representing the current process's type, can be `"browser"` (i.e.
- * main process), `"renderer"`, or `"worker"` (i.e. web worker).
- *
- */
- readonly type: string;
- /**
- * A `Boolean`. If the app is running as a Windows Store app (appx), this property
- * is `true`, for otherwise it is `undefined`.
- *
- */
- readonly windowsStore: boolean;
- }
- interface ProcessVersions {
- readonly electron: string;
- readonly chrome: string;
- }
-}
\ No newline at end of file
diff --git a/src/decl/node.d.ts b/src/decl/node.d.ts
deleted file mode 100644
index 97e8922..0000000
--- a/src/decl/node.d.ts
+++ /dev/null
@@ -1,3951 +0,0 @@
-// Type definitions for Node.js v6.x
-// Project: http://nodejs.org/
-// Definitions by: Microsoft TypeScript <http://typescriptlang.org>, DefinitelyTyped <https://github.com/DefinitelyTyped/DefinitelyTyped>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
-/************************************************
-* *
-* Node.js v6.x API *
-* *
-************************************************/
-
-interface Error {
- stack?: string;
-}
-
-interface ErrorConstructor {
- captureStackTrace(targetObject: Object, constructorOpt?: Function): void;
- stackTraceLimit: number;
-}
-
-// compat for TypeScript 1.8
-// if you use with --target es3 or --target es5 and use below definitions,
-// use the lib.es6.d.ts that is bundled with TypeScript 1.8.
-interface MapConstructor { }
-interface WeakMapConstructor { }
-interface SetConstructor { }
-interface WeakSetConstructor { }
-
-/************************************************
-* *
-* GLOBAL *
-* *
-************************************************/
-declare var process: NodeJS.Process;
-declare var global: NodeJS.Global;
-
-declare var __filename: string;
-declare var __dirname: string;
-
-declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer;
-declare function clearTimeout(timeoutId: NodeJS.Timer): void;
-declare function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer;
-declare function clearInterval(intervalId: NodeJS.Timer): void;
-declare function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any;
-declare function clearImmediate(immediateId: any): void;
-
-interface NodeRequireFunction {
- (id: string): any;
-}
-
-interface NodeRequire extends NodeRequireFunction {
- resolve(id: string): string;
- cache: any;
- extensions: any;
- main: NodeModule;
-}
-
-declare var require: NodeRequire;
-
-interface NodeModule {
- exports: any;
- require: NodeRequireFunction;
- id: string;
- filename: string;
- loaded: boolean;
- parent: NodeModule;
- children: NodeModule[];
-}
-
-declare var module: NodeModule;
-
-// Same as module.exports
-declare var exports: any;
-declare var SlowBuffer: {
- new (str: string, encoding?: string): Buffer;
- new (size: number): Buffer;
- new (size: Uint8Array): Buffer;
- new (array: any[]): Buffer;
- prototype: Buffer;
- isBuffer(obj: any): boolean;
- byteLength(string: string, encoding?: string): number;
- concat(list: Buffer[], totalLength?: number): Buffer;
-};
-
-
-// Buffer class
-type BufferEncoding = "ascii" | "utf8" | "utf16le" | "ucs2" | "binary" | "hex";
-interface Buffer extends NodeBuffer { }
-
-/**
- * Raw data is stored in instances of the Buffer class.
- * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized.
- * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
- */
-declare var Buffer: {
- /**
- * Allocates a new buffer containing the given {str}.
- *
- * @param str String to store in buffer.
- * @param encoding encoding to use, optional. Default is 'utf8'
- */
- new (str: string, encoding?: string): Buffer;
- /**
- * Allocates a new buffer of {size} octets.
- *
- * @param size count of octets to allocate.
- */
- new (size: number): Buffer;
- /**
- * Allocates a new buffer containing the given {array} of octets.
- *
- * @param array The octets to store.
- */
- new (array: Uint8Array): Buffer;
- /**
- * Produces a Buffer backed by the same allocated memory as
- * the given {ArrayBuffer}.
- *
- *
- * @param arrayBuffer The ArrayBuffer with which to share memory.
- */
- new (arrayBuffer: ArrayBuffer): Buffer;
- /**
- * Allocates a new buffer containing the given {array} of octets.
- *
- * @param array The octets to store.
- */
- new (array: any[]): Buffer;
- /**
- * Copies the passed {buffer} data onto a new {Buffer} instance.
- *
- * @param buffer The buffer to copy.
- */
- new (buffer: Buffer): Buffer;
- prototype: Buffer;
- /**
- * Allocates a new Buffer using an {array} of octets.
- *
- * @param array
- */
- from(array: any[]): Buffer;
- /**
- * When passed a reference to the .buffer property of a TypedArray instance,
- * the newly created Buffer will share the same allocated memory as the TypedArray.
- * The optional {byteOffset} and {length} arguments specify a memory range
- * within the {arrayBuffer} that will be shared by the Buffer.
- *
- * @param arrayBuffer The .buffer property of a TypedArray or a new ArrayBuffer()
- * @param byteOffset
- * @param length
- */
- from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer;
- /**
- * Copies the passed {buffer} data onto a new Buffer instance.
- *
- * @param buffer
- */
- from(buffer: Buffer): Buffer;
- /**
- * Creates a new Buffer containing the given JavaScript string {str}.
- * If provided, the {encoding} parameter identifies the character encoding.
- * If not provided, {encoding} defaults to 'utf8'.
- *
- * @param str
- */
- from(str: string, encoding?: string): Buffer;
- /**
- * Returns true if {obj} is a Buffer
- *
- * @param obj object to test.
- */
- isBuffer(obj: any): obj is Buffer;
- /**
- * Returns true if {encoding} is a valid encoding argument.
- * Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
- *
- * @param encoding string to test.
- */
- isEncoding(encoding: string): boolean;
- /**
- * Gives the actual byte length of a string. encoding defaults to 'utf8'.
- * This is not the same as String.prototype.length since that returns the number of characters in a string.
- *
- * @param string string to test.
- * @param encoding encoding used to evaluate (defaults to 'utf8')
- */
- byteLength(string: string, encoding?: string): number;
- /**
- * Returns a buffer which is the result of concatenating all the buffers in the list together.
- *
- * If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer.
- * If the list has exactly one item, then the first item of the list is returned.
- * If the list has more than one item, then a new Buffer is created.
- *
- * @param list An array of Buffer objects to concatenate
- * @param totalLength Total length of the buffers when concatenated.
- * If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.
- */
- concat(list: Buffer[], totalLength?: number): Buffer;
- /**
- * The same as buf1.compare(buf2).
- */
- compare(buf1: Buffer, buf2: Buffer): number;
- /**
- * Allocates a new buffer of {size} octets.
- *
- * @param size count of octets to allocate.
- * @param fill if specified, buffer will be initialized by calling buf.fill(fill).
- * If parameter is omitted, buffer will be filled with zeros.
- * @param encoding encoding used for call to buf.fill while initalizing
- */
- alloc(size: number, fill?: string | Buffer | number, encoding?: string): Buffer;
- /**
- * Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents
- * of the newly created Buffer are unknown and may contain sensitive data.
- *
- * @param size count of octets to allocate
- */
- allocUnsafe(size: number): Buffer;
- /**
- * Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents
- * of the newly created Buffer are unknown and may contain sensitive data.
- *
- * @param size count of octets to allocate
- */
- allocUnsafeSlow(size: number): Buffer;
-};
-
-/************************************************
-* *
-* GLOBAL INTERFACES *
-* *
-************************************************/
-declare namespace NodeJS {
- export interface ErrnoException extends Error {
- errno?: number;
- code?: string;
- path?: string;
- syscall?: string;
- stack?: string;
- }
-
- export class EventEmitter {
- addListener(event: string | symbol, listener: Function): this;
- on(event: string | symbol, listener: Function): this;
- once(event: string | symbol, listener: Function): this;
- removeListener(event: string | symbol, listener: Function): this;
- removeAllListeners(event?: string | symbol): this;
- setMaxListeners(n: number): this;
- getMaxListeners(): number;
- listeners(event: string | symbol): Function[];
- emit(event: string | symbol, ...args: any[]): boolean;
- listenerCount(type: string | symbol): number;
- // Added in Node 6...
- prependListener(event: string | symbol, listener: Function): this;
- prependOnceListener(event: string | symbol, listener: Function): this;
- eventNames(): (string | symbol)[];
- }
-
- export interface ReadableStream extends EventEmitter {
- readable: boolean;
- isTTY?: boolean;
- read(size?: number): string | Buffer;
- setEncoding(encoding: string): void;
- pause(): ReadableStream;
- resume(): ReadableStream;
- pipe<T extends WritableStream>(destination: T, options?: { end?: boolean; }): T;
- unpipe<T extends WritableStream>(destination?: T): void;
- unshift(chunk: string): void;
- unshift(chunk: Buffer): void;
- wrap(oldStream: ReadableStream): ReadableStream;
- }
-
- export interface WritableStream extends EventEmitter {
- writable: boolean;
- isTTY?: boolean;
- write(buffer: Buffer | string, cb?: Function): boolean;
- write(str: string, encoding?: string, cb?: Function): boolean;
- end(): void;
- end(buffer: Buffer, cb?: Function): void;
- end(str: string, cb?: Function): void;
- end(str: string, encoding?: string, cb?: Function): void;
- }
-
- export interface ReadWriteStream extends ReadableStream, WritableStream {
- pause(): ReadWriteStream;
- resume(): ReadWriteStream;
- }
-
- export interface Events extends EventEmitter { }
-
- export interface Domain extends Events {
- run(fn: Function): void;
- add(emitter: Events): void;
- remove(emitter: Events): void;
- bind(cb: (err: Error, data: any) => any): any;
- intercept(cb: (data: any) => any): any;
- dispose(): void;
-
- addListener(event: string, listener: Function): this;
- on(event: string, listener: Function): this;
- once(event: string, listener: Function): this;
- removeListener(event: string, listener: Function): this;
- removeAllListeners(event?: string): this;
- }
-
- export interface MemoryUsage {
- rss: number;
- heapTotal: number;
- heapUsed: number;
- }
-
- export interface ProcessVersions {
- http_parser: string;
- node: string;
- v8: string;
- ares: string;
- uv: string;
- zlib: string;
- modules: string;
- openssl: string;
- }
-
- export interface Process extends EventEmitter {
- stdout: WritableStream;
- stderr: WritableStream;
- stdin: ReadableStream;
- argv: string[];
- argv0: string;
- execArgv: string[];
- execPath: string;
- abort(): void;
- chdir(directory: string): void;
- cwd(): string;
- env: any;
- exit(code?: number): void;
- exitCode: number;
- getgid(): number;
- setgid(id: number): void;
- setgid(id: string): void;
- getuid(): number;
- setuid(id: number): void;
- setuid(id: string): void;
- version: string;
- versions: ProcessVersions;
- config: {
- target_defaults: {
- cflags: any[];
- default_configuration: string;
- defines: string[];
- include_dirs: string[];
- libraries: string[];
- };
- variables: {
- clang: number;
- host_arch: string;
- node_install_npm: boolean;
- node_install_waf: boolean;
- node_prefix: string;
- node_shared_openssl: boolean;
- node_shared_v8: boolean;
- node_shared_zlib: boolean;
- node_use_dtrace: boolean;
- node_use_etw: boolean;
- node_use_openssl: boolean;
- target_arch: string;
- v8_no_strict_aliasing: number;
- v8_use_snapshot: boolean;
- visibility: string;
- };
- };
- kill(pid: number, signal?: string | number): void;
- pid: number;
- title: string;
- arch: string;
- platform: string;
- mainModule?: NodeModule;
- memoryUsage(): MemoryUsage;
- nextTick(callback: Function, ...args: any[]): void;
- umask(mask?: number): number;
- uptime(): number;
- hrtime(time?: number[]): number[];
- domain: Domain;
-
- // Worker
- send?(message: any, sendHandle?: any): void;
- disconnect(): void;
- connected: boolean;
- }
-
- export interface Global {
- Array: typeof Array;
- ArrayBuffer: typeof ArrayBuffer;
- Boolean: typeof Boolean;
- Buffer: typeof Buffer;
- DataView: typeof DataView;
- Date: typeof Date;
- Error: typeof Error;
- EvalError: typeof EvalError;
- Float32Array: typeof Float32Array;
- Float64Array: typeof Float64Array;
- Function: typeof Function;
- GLOBAL: Global;
- Infinity: typeof Infinity;
- Int16Array: typeof Int16Array;
- Int32Array: typeof Int32Array;
- Int8Array: typeof Int8Array;
- Intl: typeof Intl;
- JSON: typeof JSON;
- Map: MapConstructor;
- Math: typeof Math;
- NaN: typeof NaN;
- Number: typeof Number;
- Object: typeof Object;
- Promise: Function;
- RangeError: typeof RangeError;
- ReferenceError: typeof ReferenceError;
- RegExp: typeof RegExp;
- Set: SetConstructor;
- String: typeof String;
- Symbol: Function;
- SyntaxError: typeof SyntaxError;
- TypeError: typeof TypeError;
- URIError: typeof URIError;
- Uint16Array: typeof Uint16Array;
- Uint32Array: typeof Uint32Array;
- Uint8Array: typeof Uint8Array;
- Uint8ClampedArray: Function;
- WeakMap: WeakMapConstructor;
- WeakSet: WeakSetConstructor;
- clearImmediate: (immediateId: any) => void;
- clearInterval: (intervalId: NodeJS.Timer) => void;
- clearTimeout: (timeoutId: NodeJS.Timer) => void;
- console: typeof console;
- decodeURI: typeof decodeURI;
- decodeURIComponent: typeof decodeURIComponent;
- encodeURI: typeof encodeURI;
- encodeURIComponent: typeof encodeURIComponent;
- escape: (str: string) => string;
- eval: typeof eval;
- global: Global;
- isFinite: typeof isFinite;
- isNaN: typeof isNaN;
- parseFloat: typeof parseFloat;
- parseInt: typeof parseInt;
- process: Process;
- root: Global;
- setImmediate: (callback: (...args: any[]) => void, ...args: any[]) => any;
- setInterval: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer;
- setTimeout: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer;
- undefined: typeof undefined;
- unescape: (str: string) => string;
- gc: () => void;
- v8debug?: any;
- }
-
- export interface Timer {
- ref(): void;
- unref(): void;
- }
-}
-
-interface IterableIterator<T> { }
-
-/**
- * @deprecated
- */
-interface NodeBuffer extends Uint8Array {
- write(string: string, offset?: number, length?: number, encoding?: string): number;
- toString(encoding?: string, start?: number, end?: number): string;
- toJSON(): { type: 'Buffer', data: any[] };
- equals(otherBuffer: Buffer): boolean;
- compare(otherBuffer: Buffer, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number;
- copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number;
- slice(start?: number, end?: number): Buffer;
- writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
- writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
- writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
- writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number;
- readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
- readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
- readIntLE(offset: number, byteLength: number, noAssert?: boolean): number;
- readIntBE(offset: number, byteLength: number, noAssert?: boolean): number;
- readUInt8(offset: number, noAssert?: boolean): number;
- readUInt16LE(offset: number, noAssert?: boolean): number;
- readUInt16BE(offset: number, noAssert?: boolean): number;
- readUInt32LE(offset: number, noAssert?: boolean): number;
- readUInt32BE(offset: number, noAssert?: boolean): number;
- readInt8(offset: number, noAssert?: boolean): number;
- readInt16LE(offset: number, noAssert?: boolean): number;
- readInt16BE(offset: number, noAssert?: boolean): number;
- readInt32LE(offset: number, noAssert?: boolean): number;
- readInt32BE(offset: number, noAssert?: boolean): number;
- readFloatLE(offset: number, noAssert?: boolean): number;
- readFloatBE(offset: number, noAssert?: boolean): number;
- readDoubleLE(offset: number, noAssert?: boolean): number;
- readDoubleBE(offset: number, noAssert?: boolean): number;
- swap16(): Buffer;
- swap32(): Buffer;
- swap64(): Buffer;
- writeUInt8(value: number, offset: number, noAssert?: boolean): number;
- writeUInt16LE(value: number, offset: number, noAssert?: boolean): number;
- writeUInt16BE(value: number, offset: number, noAssert?: boolean): number;
- writeUInt32LE(value: number, offset: number, noAssert?: boolean): number;
- writeUInt32BE(value: number, offset: number, noAssert?: boolean): number;
- writeInt8(value: number, offset: number, noAssert?: boolean): number;
- writeInt16LE(value: number, offset: number, noAssert?: boolean): number;
- writeInt16BE(value: number, offset: number, noAssert?: boolean): number;
- writeInt32LE(value: number, offset: number, noAssert?: boolean): number;
- writeInt32BE(value: number, offset: number, noAssert?: boolean): number;
- writeFloatLE(value: number, offset: number, noAssert?: boolean): number;
- writeFloatBE(value: number, offset: number, noAssert?: boolean): number;
- writeDoubleLE(value: number, offset: number, noAssert?: boolean): number;
- writeDoubleBE(value: number, offset: number, noAssert?: boolean): number;
- fill(value: any, offset?: number, end?: number): this;
- indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number;
- lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number;
- entries(): IterableIterator<[number, number]>;
- includes(value: string | number | Buffer, byteOffset?: number, encoding?: string): boolean;
- keys(): IterableIterator<number>;
- values(): IterableIterator<number>;
-}
-
-/************************************************
-* *
-* MODULES *
-* *
-************************************************/
-declare module "buffer" {
- export var INSPECT_MAX_BYTES: number;
- var BuffType: typeof Buffer;
- var SlowBuffType: typeof SlowBuffer;
- export { BuffType as Buffer, SlowBuffType as SlowBuffer };
-}
-
-declare module "querystring" {
- export interface StringifyOptions {
- encodeURIComponent?: Function;
- }
-
- export interface ParseOptions {
- maxKeys?: number;
- decodeURIComponent?: Function;
- }
-
- export function stringify<T>(obj: T, sep?: string, eq?: string, options?: StringifyOptions): string;
- export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): any;
- export function parse<T extends {}>(str: string, sep?: string, eq?: string, options?: ParseOptions): T;
- export function escape(str: string): string;
- export function unescape(str: string): string;
-}
-
-declare module "events" {
- export class EventEmitter extends NodeJS.EventEmitter {
- static EventEmitter: EventEmitter;
- static listenerCount(emitter: EventEmitter, event: string | symbol): number; // deprecated
- static defaultMaxListeners: number;
-
- addListener(event: string | symbol, listener: Function): this;
- on(event: string | symbol, listener: Function): this;
- once(event: string | symbol, listener: Function): this;
- prependListener(event: string | symbol, listener: Function): this;
- prependOnceListener(event: string | symbol, listener: Function): this;
- removeListener(event: string | symbol, listener: Function): this;
- removeAllListeners(event?: string | symbol): this;
- setMaxListeners(n: number): this;
- getMaxListeners(): number;
- listeners(event: string | symbol): Function[];
- emit(event: string | symbol, ...args: any[]): boolean;
- eventNames(): (string | symbol)[];
- listenerCount(type: string | symbol): number;
- }
-}
-
-declare module "http" {
- import * as events from "events";
- import * as net from "net";
- import * as stream from "stream";
-
- export interface RequestOptions {
- protocol?: string;
- host?: string;
- hostname?: string;
- family?: number;
- port?: number;
- localAddress?: string;
- socketPath?: string;
- method?: string;
- path?: string;
- headers?: { [key: string]: any };
- auth?: string;
- agent?: Agent | boolean;
- }
-
- export interface Server extends net.Server {
- setTimeout(msecs: number, callback: Function): void;
- maxHeadersCount: number;
- timeout: number;
- listening: boolean;
- }
- /**
- * @deprecated Use IncomingMessage
- */
- export interface ServerRequest extends IncomingMessage {
- connection: net.Socket;
- }
- export interface ServerResponse extends stream.Writable {
- // Extended base methods
- write(buffer: Buffer): boolean;
- write(buffer: Buffer, cb?: Function): boolean;
- write(str: string, cb?: Function): boolean;
- write(str: string, encoding?: string, cb?: Function): boolean;
- write(str: string, encoding?: string, fd?: string): boolean;
-
- writeContinue(): void;
- writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void;
- writeHead(statusCode: number, headers?: any): void;
- statusCode: number;
- statusMessage: string;
- headersSent: boolean;
- setHeader(name: string, value: string | string[]): void;
- setTimeout(msecs: number, callback: Function): ServerResponse;
- sendDate: boolean;
- getHeader(name: string): string;
- removeHeader(name: string): void;
- write(chunk: any, encoding?: string): any;
- addTrailers(headers: any): void;
- finished: boolean;
-
- // Extended base methods
- end(): void;
- end(buffer: Buffer, cb?: Function): void;
- end(str: string, cb?: Function): void;
- end(str: string, encoding?: string, cb?: Function): void;
- end(data?: any, encoding?: string): void;
- }
- export interface ClientRequest extends stream.Writable {
- // Extended base methods
- write(buffer: Buffer): boolean;
- write(buffer: Buffer, cb?: Function): boolean;
- write(str: string, cb?: Function): boolean;
- write(str: string, encoding?: string, cb?: Function): boolean;
- write(str: string, encoding?: string, fd?: string): boolean;
-
- write(chunk: any, encoding?: string): void;
- abort(): void;
- setTimeout(timeout: number, callback?: Function): void;
- setNoDelay(noDelay?: boolean): void;
- setSocketKeepAlive(enable?: boolean, initialDelay?: number): void;
-
- setHeader(name: string, value: string | string[]): void;
- getHeader(name: string): string;
- removeHeader(name: string): void;
- addTrailers(headers: any): void;
-
- // Extended base methods
- end(): void;
- end(buffer: Buffer, cb?: Function): void;
- end(str: string, cb?: Function): void;
- end(str: string, encoding?: string, cb?: Function): void;
- end(data?: any, encoding?: string): void;
- }
- export interface IncomingMessage extends stream.Readable {
- httpVersion: string;
- httpVersionMajor: number;
- httpVersionMinor: number;
- connection: net.Socket;
- headers: any;
- rawHeaders: string[];
- trailers: any;
- rawTrailers: any;
- setTimeout(msecs: number, callback: Function): NodeJS.Timer;
- /**
- * Only valid for request obtained from http.Server.
- */
- method?: string;
- /**
- * Only valid for request obtained from http.Server.
- */
- url?: string;
- /**
- * Only valid for response obtained from http.ClientRequest.
- */
- statusCode?: number;
- /**
- * Only valid for response obtained from http.ClientRequest.
- */
- statusMessage?: string;
- socket: net.Socket;
- destroy(error?: Error): void;
- }
- /**
- * @deprecated Use IncomingMessage
- */
- export interface ClientResponse extends IncomingMessage { }
-
- export interface AgentOptions {
- /**
- * Keep sockets around in a pool to be used by other requests in the future. Default = false
- */
- keepAlive?: boolean;
- /**
- * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000.
- * Only relevant if keepAlive is set to true.
- */
- keepAliveMsecs?: number;
- /**
- * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity
- */
- maxSockets?: number;
- /**
- * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.
- */
- maxFreeSockets?: number;
- }
-
- export class Agent {
- maxSockets: number;
- sockets: any;
- requests: any;
-
- constructor(opts?: AgentOptions);
-
- /**
- * Destroy any sockets that are currently in use by the agent.
- * It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled,
- * then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise,
- * sockets may hang open for quite a long time before the server terminates them.
- */
- destroy(): void;
- }
-
- export var METHODS: string[];
-
- export var STATUS_CODES: {
- [errorCode: number]: string;
- [errorCode: string]: string;
- };
- export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) => void): Server;
- export function createClient(port?: number, host?: string): any;
- export function request(options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;
- export function get(options: any, callback?: (res: IncomingMessage) => void): ClientRequest;
- export var globalAgent: Agent;
-}
-
-declare module "cluster" {
- import * as child from "child_process";
- import * as events from "events";
- import * as net from "net";
-
- // interfaces
- export interface ClusterSettings {
- execArgv?: string[]; // default: process.execArgv
- exec?: string;
- args?: string[];
- silent?: boolean;
- stdio?: any[];
- uid?: number;
- gid?: number;
- }
-
- export interface ClusterSetupMasterSettings {
- exec?: string; // default: process.argv[1]
- args?: string[]; // default: process.argv.slice(2)
- silent?: boolean; // default: false
- stdio?: any[];
- }
-
- export interface Address {
- address: string;
- port: number;
- addressType: number | "udp4" | "udp6"; // 4, 6, -1, "udp4", "udp6"
- }
-
- export class Worker extends events.EventEmitter {
- id: string;
- process: child.ChildProcess;
- suicide: boolean;
- send(message: any, sendHandle?: any): boolean;
- kill(signal?: string): void;
- destroy(signal?: string): void;
- disconnect(): void;
- isConnected(): boolean;
- isDead(): boolean;
- exitedAfterDisconnect: boolean;
-
- /**
- * events.EventEmitter
- * 1. disconnect
- * 2. error
- * 3. exit
- * 4. listening
- * 5. message
- * 6. online
- */
- addListener(event: string, listener: Function): this;
- addListener(event: "disconnect", listener: () => void): this;
- addListener(event: "error", listener: (code: number, signal: string) => void): this;
- addListener(event: "exit", listener: (code: number, signal: string) => void): this;
- addListener(event: "listening", listener: (address: Address) => void): this;
- addListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- addListener(event: "online", listener: () => void): this;
-
- emit(event: string, listener: Function): boolean
- emit(event: "disconnect", listener: () => void): boolean
- emit(event: "error", listener: (code: number, signal: string) => void): boolean
- emit(event: "exit", listener: (code: number, signal: string) => void): boolean
- emit(event: "listening", listener: (address: Address) => void): boolean
- emit(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): boolean
- emit(event: "online", listener: () => void): boolean
-
- on(event: string, listener: Function): this;
- on(event: "disconnect", listener: () => void): this;
- on(event: "error", listener: (code: number, signal: string) => void): this;
- on(event: "exit", listener: (code: number, signal: string) => void): this;
- on(event: "listening", listener: (address: Address) => void): this;
- on(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- on(event: "online", listener: () => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "disconnect", listener: () => void): this;
- once(event: "error", listener: (code: number, signal: string) => void): this;
- once(event: "exit", listener: (code: number, signal: string) => void): this;
- once(event: "listening", listener: (address: Address) => void): this;
- once(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- once(event: "online", listener: () => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "disconnect", listener: () => void): this;
- prependListener(event: "error", listener: (code: number, signal: string) => void): this;
- prependListener(event: "exit", listener: (code: number, signal: string) => void): this;
- prependListener(event: "listening", listener: (address: Address) => void): this;
- prependListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- prependListener(event: "online", listener: () => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "disconnect", listener: () => void): this;
- prependOnceListener(event: "error", listener: (code: number, signal: string) => void): this;
- prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this;
- prependOnceListener(event: "listening", listener: (address: Address) => void): this;
- prependOnceListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- prependOnceListener(event: "online", listener: () => void): this;
- }
-
- export interface Cluster extends events.EventEmitter {
- Worker: Worker;
- disconnect(callback?: Function): void;
- fork(env?: any): Worker;
- isMaster: boolean;
- isWorker: boolean;
- // TODO: cluster.schedulingPolicy
- settings: ClusterSettings;
- setupMaster(settings?: ClusterSetupMasterSettings): void;
- worker: Worker;
- workers: {
- [index: string]: Worker
- };
-
- /**
- * events.EventEmitter
- * 1. disconnect
- * 2. exit
- * 3. fork
- * 4. listening
- * 5. message
- * 6. online
- * 7. setup
- */
- addListener(event: string, listener: Function): this;
- addListener(event: "disconnect", listener: (worker: Worker) => void): this;
- addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- addListener(event: "fork", listener: (worker: Worker) => void): this;
- addListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- addListener(event: "online", listener: (worker: Worker) => void): this;
- addListener(event: "setup", listener: (settings: any) => void): this;
-
- emit(event: string, listener: Function): boolean;
- emit(event: "disconnect", listener: (worker: Worker) => void): boolean;
- emit(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): boolean;
- emit(event: "fork", listener: (worker: Worker) => void): boolean;
- emit(event: "listening", listener: (worker: Worker, address: Address) => void): boolean;
- emit(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): boolean;
- emit(event: "online", listener: (worker: Worker) => void): boolean;
- emit(event: "setup", listener: (settings: any) => void): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "disconnect", listener: (worker: Worker) => void): this;
- on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- on(event: "fork", listener: (worker: Worker) => void): this;
- on(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- on(event: "online", listener: (worker: Worker) => void): this;
- on(event: "setup", listener: (settings: any) => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "disconnect", listener: (worker: Worker) => void): this;
- once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- once(event: "fork", listener: (worker: Worker) => void): this;
- once(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- once(event: "online", listener: (worker: Worker) => void): this;
- once(event: "setup", listener: (settings: any) => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "disconnect", listener: (worker: Worker) => void): this;
- prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- prependListener(event: "fork", listener: (worker: Worker) => void): this;
- prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- prependListener(event: "online", listener: (worker: Worker) => void): this;
- prependListener(event: "setup", listener: (settings: any) => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): this;
- prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this;
- prependOnceListener(event: "fork", listener: (worker: Worker) => void): this;
- prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): this;
- prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined.
- prependOnceListener(event: "online", listener: (worker: Worker) => void): this;
- prependOnceListener(event: "setup", listener: (settings: any) => void): this;
-
- }
-
- export function disconnect(callback?: Function): void;
- export function fork(env?: any): Worker;
- export var isMaster: boolean;
- export var isWorker: boolean;
- // TODO: cluster.schedulingPolicy
- export var settings: ClusterSettings;
- export function setupMaster(settings?: ClusterSetupMasterSettings): void;
- export var worker: Worker;
- export var workers: {
- [index: string]: Worker
- };
-
- /**
- * events.EventEmitter
- * 1. disconnect
- * 2. exit
- * 3. fork
- * 4. listening
- * 5. message
- * 6. online
- * 7. setup
- */
- export function addListener(event: string, listener: Function): Cluster;
- export function addListener(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- export function addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- export function addListener(event: "fork", listener: (worker: Worker) => void): Cluster;
- export function addListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- export function addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined.
- export function addListener(event: "online", listener: (worker: Worker) => void): Cluster;
- export function addListener(event: "setup", listener: (settings: any) => void): Cluster;
-
- export function emit(event: string, listener: Function): boolean;
- export function emit(event: "disconnect", listener: (worker: Worker) => void): boolean;
- export function emit(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): boolean;
- export function emit(event: "fork", listener: (worker: Worker) => void): boolean;
- export function emit(event: "listening", listener: (worker: Worker, address: Address) => void): boolean;
- export function emit(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): boolean;
- export function emit(event: "online", listener: (worker: Worker) => void): boolean;
- export function emit(event: "setup", listener: (settings: any) => void): boolean;
-
- export function on(event: string, listener: Function): Cluster;
- export function on(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- export function on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- export function on(event: "fork", listener: (worker: Worker) => void): Cluster;
- export function on(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- export function on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined.
- export function on(event: "online", listener: (worker: Worker) => void): Cluster;
- export function on(event: "setup", listener: (settings: any) => void): Cluster;
-
- export function once(event: string, listener: Function): Cluster;
- export function once(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- export function once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- export function once(event: "fork", listener: (worker: Worker) => void): Cluster;
- export function once(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- export function once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined.
- export function once(event: "online", listener: (worker: Worker) => void): Cluster;
- export function once(event: "setup", listener: (settings: any) => void): Cluster;
-
- export function removeListener(event: string, listener: Function): Cluster;
- export function removeAllListeners(event?: string): Cluster;
- export function setMaxListeners(n: number): Cluster;
- export function getMaxListeners(): number;
- export function listeners(event: string): Function[];
- export function listenerCount(type: string): number;
-
- export function prependListener(event: string, listener: Function): Cluster;
- export function prependListener(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- export function prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- export function prependListener(event: "fork", listener: (worker: Worker) => void): Cluster;
- export function prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- export function prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined.
- export function prependListener(event: "online", listener: (worker: Worker) => void): Cluster;
- export function prependListener(event: "setup", listener: (settings: any) => void): Cluster;
-
- export function prependOnceListener(event: string, listener: Function): Cluster;
- export function prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): Cluster;
- export function prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster;
- export function prependOnceListener(event: "fork", listener: (worker: Worker) => void): Cluster;
- export function prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster;
- export function prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined.
- export function prependOnceListener(event: "online", listener: (worker: Worker) => void): Cluster;
- export function prependOnceListener(event: "setup", listener: (settings: any) => void): Cluster;
-
- export function eventNames(): string[];
-}
-
-declare module "zlib" {
- import * as stream from "stream";
- export interface ZlibOptions { chunkSize?: number; windowBits?: number; level?: number; memLevel?: number; strategy?: number; dictionary?: any; }
-
- export interface Gzip extends stream.Transform { }
- export interface Gunzip extends stream.Transform { }
- export interface Deflate extends stream.Transform { }
- export interface Inflate extends stream.Transform { }
- export interface DeflateRaw extends stream.Transform { }
- export interface InflateRaw extends stream.Transform { }
- export interface Unzip extends stream.Transform { }
-
- export function createGzip(options?: ZlibOptions): Gzip;
- export function createGunzip(options?: ZlibOptions): Gunzip;
- export function createDeflate(options?: ZlibOptions): Deflate;
- export function createInflate(options?: ZlibOptions): Inflate;
- export function createDeflateRaw(options?: ZlibOptions): DeflateRaw;
- export function createInflateRaw(options?: ZlibOptions): InflateRaw;
- export function createUnzip(options?: ZlibOptions): Unzip;
-
- export function deflate(buf: Buffer, callback: (error: Error, result: any) => void): void;
- export function deflateSync(buf: Buffer, options?: ZlibOptions): any;
- export function deflateRaw(buf: Buffer, callback: (error: Error, result: any) => void): void;
- export function deflateRawSync(buf: Buffer, options?: ZlibOptions): any;
- export function gzip(buf: Buffer, callback: (error: Error, result: any) => void): void;
- export function gzipSync(buf: Buffer, options?: ZlibOptions): any;
- export function gunzip(buf: Buffer, callback: (error: Error, result: any) => void): void;
- export function gunzipSync(buf: Buffer, options?: ZlibOptions): any;
- export function inflate(buf: Buffer, callback: (error: Error, result: any) => void): void;
- export function inflateSync(buf: Buffer, options?: ZlibOptions): any;
- export function inflateRaw(buf: Buffer, callback: (error: Error, result: any) => void): void;
- export function inflateRawSync(buf: Buffer, options?: ZlibOptions): any;
- export function unzip(buf: Buffer, callback: (error: Error, result: any) => void): void;
- export function unzipSync(buf: Buffer, options?: ZlibOptions): any;
-
- // Constants
- export var Z_NO_FLUSH: number;
- export var Z_PARTIAL_FLUSH: number;
- export var Z_SYNC_FLUSH: number;
- export var Z_FULL_FLUSH: number;
- export var Z_FINISH: number;
- export var Z_BLOCK: number;
- export var Z_TREES: number;
- export var Z_OK: number;
- export var Z_STREAM_END: number;
- export var Z_NEED_DICT: number;
- export var Z_ERRNO: number;
- export var Z_STREAM_ERROR: number;
- export var Z_DATA_ERROR: number;
- export var Z_MEM_ERROR: number;
- export var Z_BUF_ERROR: number;
- export var Z_VERSION_ERROR: number;
- export var Z_NO_COMPRESSION: number;
- export var Z_BEST_SPEED: number;
- export var Z_BEST_COMPRESSION: number;
- export var Z_DEFAULT_COMPRESSION: number;
- export var Z_FILTERED: number;
- export var Z_HUFFMAN_ONLY: number;
- export var Z_RLE: number;
- export var Z_FIXED: number;
- export var Z_DEFAULT_STRATEGY: number;
- export var Z_BINARY: number;
- export var Z_TEXT: number;
- export var Z_ASCII: number;
- export var Z_UNKNOWN: number;
- export var Z_DEFLATED: number;
- export var Z_NULL: number;
-}
-
-declare module "os" {
- export interface CpuInfo {
- model: string;
- speed: number;
- times: {
- user: number;
- nice: number;
- sys: number;
- idle: number;
- irq: number;
- };
- }
-
- export interface NetworkInterfaceInfo {
- address: string;
- netmask: string;
- family: string;
- mac: string;
- internal: boolean;
- }
-
- export function hostname(): string;
- export function loadavg(): number[];
- export function uptime(): number;
- export function freemem(): number;
- export function totalmem(): number;
- export function cpus(): CpuInfo[];
- export function type(): string;
- export function release(): string;
- export function networkInterfaces(): { [index: string]: NetworkInterfaceInfo[] };
- export function homedir(): string;
- export function userInfo(options?: { encoding: string }): { username: string, uid: number, gid: number, shell: any, homedir: string }
- export var constants: {
- UV_UDP_REUSEADDR: number,
- errno: {
- SIGHUP: number;
- SIGINT: number;
- SIGQUIT: number;
- SIGILL: number;
- SIGTRAP: number;
- SIGABRT: number;
- SIGIOT: number;
- SIGBUS: number;
- SIGFPE: number;
- SIGKILL: number;
- SIGUSR1: number;
- SIGSEGV: number;
- SIGUSR2: number;
- SIGPIPE: number;
- SIGALRM: number;
- SIGTERM: number;
- SIGCHLD: number;
- SIGSTKFLT: number;
- SIGCONT: number;
- SIGSTOP: number;
- SIGTSTP: number;
- SIGTTIN: number;
- SIGTTOU: number;
- SIGURG: number;
- SIGXCPU: number;
- SIGXFSZ: number;
- SIGVTALRM: number;
- SIGPROF: number;
- SIGWINCH: number;
- SIGIO: number;
- SIGPOLL: number;
- SIGPWR: number;
- SIGSYS: number;
- SIGUNUSED: number;
- },
- signals: {
- E2BIG: number;
- EACCES: number;
- EADDRINUSE: number;
- EADDRNOTAVAIL: number;
- EAFNOSUPPORT: number;
- EAGAIN: number;
- EALREADY: number;
- EBADF: number;
- EBADMSG: number;
- EBUSY: number;
- ECANCELED: number;
- ECHILD: number;
- ECONNABORTED: number;
- ECONNREFUSED: number;
- ECONNRESET: number;
- EDEADLK: number;
- EDESTADDRREQ: number;
- EDOM: number;
- EDQUOT: number;
- EEXIST: number;
- EFAULT: number;
- EFBIG: number;
- EHOSTUNREACH: number;
- EIDRM: number;
- EILSEQ: number;
- EINPROGRESS: number;
- EINTR: number;
- EINVAL: number;
- EIO: number;
- EISCONN: number;
- EISDIR: number;
- ELOOP: number;
- EMFILE: number;
- EMLINK: number;
- EMSGSIZE: number;
- EMULTIHOP: number;
- ENAMETOOLONG: number;
- ENETDOWN: number;
- ENETRESET: number;
- ENETUNREACH: number;
- ENFILE: number;
- ENOBUFS: number;
- ENODATA: number;
- ENODEV: number;
- ENOENT: number;
- ENOEXEC: number;
- ENOLCK: number;
- ENOLINK: number;
- ENOMEM: number;
- ENOMSG: number;
- ENOPROTOOPT: number;
- ENOSPC: number;
- ENOSR: number;
- ENOSTR: number;
- ENOSYS: number;
- ENOTCONN: number;
- ENOTDIR: number;
- ENOTEMPTY: number;
- ENOTSOCK: number;
- ENOTSUP: number;
- ENOTTY: number;
- ENXIO: number;
- EOPNOTSUPP: number;
- EOVERFLOW: number;
- EPERM: number;
- EPIPE: number;
- EPROTO: number;
- EPROTONOSUPPORT: number;
- EPROTOTYPE: number;
- ERANGE: number;
- EROFS: number;
- ESPIPE: number;
- ESRCH: number;
- ESTALE: number;
- ETIME: number;
- ETIMEDOUT: number;
- ETXTBSY: number;
- EWOULDBLOCK: number;
- EXDEV: number;
- },
- };
- export function arch(): string;
- export function platform(): string;
- export function tmpdir(): string;
- export var EOL: string;
- export function endianness(): "BE" | "LE";
-}
-
-declare module "https" {
- import * as tls from "tls";
- import * as events from "events";
- import * as http from "http";
-
- export interface ServerOptions {
- pfx?: any;
- key?: any;
- passphrase?: string;
- cert?: any;
- ca?: any;
- crl?: any;
- ciphers?: string;
- honorCipherOrder?: boolean;
- requestCert?: boolean;
- rejectUnauthorized?: boolean;
- NPNProtocols?: any;
- SNICallback?: (servername: string, cb: (err: Error, ctx: tls.SecureContext) => any) => any;
- }
-
- export interface RequestOptions extends http.RequestOptions {
- pfx?: any;
- key?: any;
- passphrase?: string;
- cert?: any;
- ca?: any;
- ciphers?: string;
- rejectUnauthorized?: boolean;
- secureProtocol?: string;
- }
-
- export interface Agent extends http.Agent { }
-
- export interface AgentOptions extends http.AgentOptions {
- pfx?: any;
- key?: any;
- passphrase?: string;
- cert?: any;
- ca?: any;
- ciphers?: string;
- rejectUnauthorized?: boolean;
- secureProtocol?: string;
- maxCachedSessions?: number;
- }
-
- export var Agent: {
- new (options?: AgentOptions): Agent;
- };
- export interface Server extends tls.Server { }
- export function createServer(options: ServerOptions, requestListener?: Function): Server;
- export function request(options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest;
- export function get(options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest;
- export var globalAgent: Agent;
-}
-
-declare module "punycode" {
- export function decode(string: string): string;
- export function encode(string: string): string;
- export function toUnicode(domain: string): string;
- export function toASCII(domain: string): string;
- export var ucs2: ucs2;
- interface ucs2 {
- decode(string: string): number[];
- encode(codePoints: number[]): string;
- }
- export var version: any;
-}
-
-declare module "repl" {
- import * as stream from "stream";
- import * as readline from "readline";
-
- export interface ReplOptions {
- prompt?: string;
- input?: NodeJS.ReadableStream;
- output?: NodeJS.WritableStream;
- terminal?: boolean;
- eval?: Function;
- useColors?: boolean;
- useGlobal?: boolean;
- ignoreUndefined?: boolean;
- writer?: Function;
- completer?: Function;
- replMode?: any;
- breakEvalOnSigint?: any;
- }
-
- export interface REPLServer extends readline.ReadLine {
- defineCommand(keyword: string, cmd: Function | { help: string, action: Function }): void;
- displayPrompt(preserveCursor?: boolean): void;
-
- /**
- * events.EventEmitter
- * 1. exit
- * 2. reset
- **/
-
- addListener(event: string, listener: Function): this;
- addListener(event: "exit", listener: () => void): this;
- addListener(event: "reset", listener: Function): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "exit"): boolean;
- emit(event: "reset", context: any): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "exit", listener: () => void): this;
- on(event: "reset", listener: Function): this;
-
- once(event: string, listener: Function): this;
- once(event: "exit", listener: () => void): this;
- once(event: "reset", listener: Function): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "exit", listener: () => void): this;
- prependListener(event: "reset", listener: Function): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "exit", listener: () => void): this;
- prependOnceListener(event: "reset", listener: Function): this;
- }
-
- export function start(options: ReplOptions): REPLServer;
-}
-
-declare module "readline" {
- import * as events from "events";
- import * as stream from "stream";
-
- export interface Key {
- sequence?: string;
- name?: string;
- ctrl?: boolean;
- meta?: boolean;
- shift?: boolean;
- }
-
- export interface ReadLine extends events.EventEmitter {
- setPrompt(prompt: string): void;
- prompt(preserveCursor?: boolean): void;
- question(query: string, callback: (answer: string) => void): void;
- pause(): ReadLine;
- resume(): ReadLine;
- close(): void;
- write(data: string | Buffer, key?: Key): void;
-
- /**
- * events.EventEmitter
- * 1. close
- * 2. line
- * 3. pause
- * 4. resume
- * 5. SIGCONT
- * 6. SIGINT
- * 7. SIGTSTP
- **/
-
- addListener(event: string, listener: Function): this;
- addListener(event: "close", listener: () => void): this;
- addListener(event: "line", listener: (input: any) => void): this;
- addListener(event: "pause", listener: () => void): this;
- addListener(event: "resume", listener: () => void): this;
- addListener(event: "SIGCONT", listener: () => void): this;
- addListener(event: "SIGINT", listener: () => void): this;
- addListener(event: "SIGTSTP", listener: () => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "close"): boolean;
- emit(event: "line", input: any): boolean;
- emit(event: "pause"): boolean;
- emit(event: "resume"): boolean;
- emit(event: "SIGCONT"): boolean;
- emit(event: "SIGINT"): boolean;
- emit(event: "SIGTSTP"): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "close", listener: () => void): this;
- on(event: "line", listener: (input: any) => void): this;
- on(event: "pause", listener: () => void): this;
- on(event: "resume", listener: () => void): this;
- on(event: "SIGCONT", listener: () => void): this;
- on(event: "SIGINT", listener: () => void): this;
- on(event: "SIGTSTP", listener: () => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "close", listener: () => void): this;
- once(event: "line", listener: (input: any) => void): this;
- once(event: "pause", listener: () => void): this;
- once(event: "resume", listener: () => void): this;
- once(event: "SIGCONT", listener: () => void): this;
- once(event: "SIGINT", listener: () => void): this;
- once(event: "SIGTSTP", listener: () => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "close", listener: () => void): this;
- prependListener(event: "line", listener: (input: any) => void): this;
- prependListener(event: "pause", listener: () => void): this;
- prependListener(event: "resume", listener: () => void): this;
- prependListener(event: "SIGCONT", listener: () => void): this;
- prependListener(event: "SIGINT", listener: () => void): this;
- prependListener(event: "SIGTSTP", listener: () => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "close", listener: () => void): this;
- prependOnceListener(event: "line", listener: (input: any) => void): this;
- prependOnceListener(event: "pause", listener: () => void): this;
- prependOnceListener(event: "resume", listener: () => void): this;
- prependOnceListener(event: "SIGCONT", listener: () => void): this;
- prependOnceListener(event: "SIGINT", listener: () => void): this;
- prependOnceListener(event: "SIGTSTP", listener: () => void): this;
- }
-
- export interface Completer {
- (line: string): CompleterResult;
- (line: string, callback: (err: any, result: CompleterResult) => void): any;
- }
-
- export interface CompleterResult {
- completions: string[];
- line: string;
- }
-
- export interface ReadLineOptions {
- input: NodeJS.ReadableStream;
- output?: NodeJS.WritableStream;
- completer?: Completer;
- terminal?: boolean;
- historySize?: number;
- }
-
- export function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer, terminal?: boolean): ReadLine;
- export function createInterface(options: ReadLineOptions): ReadLine;
-
- export function cursorTo(stream: NodeJS.WritableStream, x: number, y: number): void;
- export function moveCursor(stream: NodeJS.WritableStream, dx: number | string, dy: number | string): void;
- export function clearLine(stream: NodeJS.WritableStream, dir: number): void;
- export function clearScreenDown(stream: NodeJS.WritableStream): void;
-}
-
-declare module "vm" {
- export interface Context { }
- export interface ScriptOptions {
- filename?: string;
- lineOffset?: number;
- columnOffset?: number;
- displayErrors?: boolean;
- timeout?: number;
- cachedData?: Buffer;
- produceCachedData?: boolean;
- }
- export interface RunningScriptOptions {
- filename?: string;
- lineOffset?: number;
- columnOffset?: number;
- displayErrors?: boolean;
- timeout?: number;
- }
- export class Script {
- constructor(code: string, options?: ScriptOptions);
- runInContext(contextifiedSandbox: Context, options?: RunningScriptOptions): any;
- runInNewContext(sandbox?: Context, options?: RunningScriptOptions): any;
- runInThisContext(options?: RunningScriptOptions): any;
- }
- export function createContext(sandbox?: Context): Context;
- export function isContext(sandbox: Context): boolean;
- export function runInContext(code: string, contextifiedSandbox: Context, options?: RunningScriptOptions): any;
- export function runInDebugContext(code: string): any;
- export function runInNewContext(code: string, sandbox?: Context, options?: RunningScriptOptions): any;
- export function runInThisContext(code: string, options?: RunningScriptOptions): any;
-}
-
-declare module "child_process" {
- import * as events from "events";
- import * as stream from "stream";
- import * as net from "net";
-
- export interface ChildProcess extends events.EventEmitter {
- stdin: stream.Writable;
- stdout: stream.Readable;
- stderr: stream.Readable;
- stdio: [stream.Writable, stream.Readable, stream.Readable];
- pid: number;
- kill(signal?: string): void;
- send(message: any, sendHandle?: any): boolean;
- connected: boolean;
- disconnect(): void;
- unref(): void;
- ref(): void;
-
- /**
- * events.EventEmitter
- * 1. close
- * 2. disconnet
- * 3. error
- * 4. exit
- * 5. message
- **/
-
- addListener(event: string, listener: Function): this;
- addListener(event: "close", listener: (code: number, signal: string) => void): this;
- addListener(event: "disconnet", listener: () => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
- addListener(event: "exit", listener: (code: number, signal: string) => void): this;
- addListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "close", code: number, signal: string): boolean;
- emit(event: "disconnet"): boolean;
- emit(event: "error", err: Error): boolean;
- emit(event: "exit", code: number, signal: string): boolean;
- emit(event: "message", message: any, sendHandle: net.Socket | net.Server): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "close", listener: (code: number, signal: string) => void): this;
- on(event: "disconnet", listener: () => void): this;
- on(event: "error", listener: (err: Error) => void): this;
- on(event: "exit", listener: (code: number, signal: string) => void): this;
- on(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "close", listener: (code: number, signal: string) => void): this;
- once(event: "disconnet", listener: () => void): this;
- once(event: "error", listener: (err: Error) => void): this;
- once(event: "exit", listener: (code: number, signal: string) => void): this;
- once(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "close", listener: (code: number, signal: string) => void): this;
- prependListener(event: "disconnet", listener: () => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
- prependListener(event: "exit", listener: (code: number, signal: string) => void): this;
- prependListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "close", listener: (code: number, signal: string) => void): this;
- prependOnceListener(event: "disconnet", listener: () => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
- prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this;
- prependOnceListener(event: "message", listener: (message: any, sendHandle: net.Socket | net.Server) => void): this;
- }
-
- export interface SpawnOptions {
- cwd?: string;
- env?: any;
- stdio?: any;
- detached?: boolean;
- uid?: number;
- gid?: number;
- shell?: boolean | string;
- }
- export function spawn(command: string, args?: string[], options?: SpawnOptions): ChildProcess;
-
- export interface ExecOptions {
- cwd?: string;
- env?: any;
- shell?: string;
- timeout?: number;
- maxBuffer?: number;
- killSignal?: string;
- uid?: number;
- gid?: number;
- }
- export interface ExecOptionsWithStringEncoding extends ExecOptions {
- encoding: BufferEncoding;
- }
- export interface ExecOptionsWithBufferEncoding extends ExecOptions {
- encoding: string; // specify `null`.
- }
- export function exec(command: string, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
- export function exec(command: string, options: ExecOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
- // usage. child_process.exec("tsc", {encoding: null as string}, (err, stdout, stderr) => {});
- export function exec(command: string, options: ExecOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess;
- export function exec(command: string, options: ExecOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
-
- export interface ExecFileOptions {
- cwd?: string;
- env?: any;
- timeout?: number;
- maxBuffer?: number;
- killSignal?: string;
- uid?: number;
- gid?: number;
- }
- export interface ExecFileOptionsWithStringEncoding extends ExecFileOptions {
- encoding: BufferEncoding;
- }
- export interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions {
- encoding: string; // specify `null`.
- }
- export function execFile(file: string, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
- export function execFile(file: string, options?: ExecFileOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
- // usage. child_process.execFile("file.sh", {encoding: null as string}, (err, stdout, stderr) => {});
- export function execFile(file: string, options?: ExecFileOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess;
- export function execFile(file: string, options?: ExecFileOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
- export function execFile(file: string, args?: string[], callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
- export function execFile(file: string, args?: string[], options?: ExecFileOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
- // usage. child_process.execFile("file.sh", ["foo"], {encoding: null as string}, (err, stdout, stderr) => {});
- export function execFile(file: string, args?: string[], options?: ExecFileOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess;
- export function execFile(file: string, args?: string[], options?: ExecFileOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess;
-
- export interface ForkOptions {
- cwd?: string;
- env?: any;
- execPath?: string;
- execArgv?: string[];
- silent?: boolean;
- uid?: number;
- gid?: number;
- }
- export function fork(modulePath: string, args?: string[], options?: ForkOptions): ChildProcess;
-
- export interface SpawnSyncOptions {
- cwd?: string;
- input?: string | Buffer;
- stdio?: any;
- env?: any;
- uid?: number;
- gid?: number;
- timeout?: number;
- killSignal?: string;
- maxBuffer?: number;
- encoding?: string;
- shell?: boolean | string;
- }
- export interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions {
- encoding: BufferEncoding;
- }
- export interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions {
- encoding: string; // specify `null`.
- }
- export interface SpawnSyncReturns<T> {
- pid: number;
- output: string[];
- stdout: T;
- stderr: T;
- status: number;
- signal: string;
- error: Error;
- }
- export function spawnSync(command: string): SpawnSyncReturns<Buffer>;
- export function spawnSync(command: string, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns<string>;
- export function spawnSync(command: string, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns<Buffer>;
- export function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns<Buffer>;
- export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns<string>;
- export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns<Buffer>;
- export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptions): SpawnSyncReturns<Buffer>;
-
- export interface ExecSyncOptions {
- cwd?: string;
- input?: string | Buffer;
- stdio?: any;
- env?: any;
- shell?: string;
- uid?: number;
- gid?: number;
- timeout?: number;
- killSignal?: string;
- maxBuffer?: number;
- encoding?: string;
- }
- export interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions {
- encoding: BufferEncoding;
- }
- export interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions {
- encoding: string; // specify `null`.
- }
- export function execSync(command: string): Buffer;
- export function execSync(command: string, options?: ExecSyncOptionsWithStringEncoding): string;
- export function execSync(command: string, options?: ExecSyncOptionsWithBufferEncoding): Buffer;
- export function execSync(command: string, options?: ExecSyncOptions): Buffer;
-
- export interface ExecFileSyncOptions {
- cwd?: string;
- input?: string | Buffer;
- stdio?: any;
- env?: any;
- uid?: number;
- gid?: number;
- timeout?: number;
- killSignal?: string;
- maxBuffer?: number;
- encoding?: string;
- }
- export interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions {
- encoding: BufferEncoding;
- }
- export interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions {
- encoding: string; // specify `null`.
- }
- export function execFileSync(command: string): Buffer;
- export function execFileSync(command: string, options?: ExecFileSyncOptionsWithStringEncoding): string;
- export function execFileSync(command: string, options?: ExecFileSyncOptionsWithBufferEncoding): Buffer;
- export function execFileSync(command: string, options?: ExecFileSyncOptions): Buffer;
- export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptionsWithStringEncoding): string;
- export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptionsWithBufferEncoding): Buffer;
- export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptions): Buffer;
-}
-
-declare module "url" {
- export interface Url {
- href?: string;
- protocol?: string;
- auth?: string;
- hostname?: string;
- port?: string;
- host?: string;
- pathname?: string;
- search?: string;
- query?: string | any;
- slashes?: boolean;
- hash?: string;
- path?: string;
- }
-
- export function parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url;
- export function format(url: Url): string;
- export function resolve(from: string, to: string): string;
-}
-
-declare module "dns" {
- export interface MxRecord {
- exchange: string,
- priority: number
- }
-
- export function lookup(domain: string, family: number, callback: (err: Error, address: string, family: number) => void): string;
- export function lookup(domain: string, callback: (err: Error, address: string, family: number) => void): string;
- export function resolve(domain: string, rrtype: string, callback: (err: Error, addresses: string[]) => void): string[];
- export function resolve(domain: string, callback: (err: Error, addresses: string[]) => void): string[];
- export function resolve4(domain: string, callback: (err: Error, addresses: string[]) => void): string[];
- export function resolve6(domain: string, callback: (err: Error, addresses: string[]) => void): string[];
- export function resolveMx(domain: string, callback: (err: Error, addresses: MxRecord[]) => void): string[];
- export function resolveTxt(domain: string, callback: (err: Error, addresses: string[]) => void): string[];
- export function resolveSrv(domain: string, callback: (err: Error, addresses: string[]) => void): string[];
- export function resolveNs(domain: string, callback: (err: Error, addresses: string[]) => void): string[];
- export function resolveCname(domain: string, callback: (err: Error, addresses: string[]) => void): string[];
- export function reverse(ip: string, callback: (err: Error, domains: string[]) => void): string[];
- export function setServers(servers: string[]): void;
-
- //Error codes
- export var NODATA: string;
- export var FORMERR: string;
- export var SERVFAIL: string;
- export var NOTFOUND: string;
- export var NOTIMP: string;
- export var REFUSED: string;
- export var BADQUERY: string;
- export var BADNAME: string;
- export var BADFAMILY: string;
- export var BADRESP: string;
- export var CONNREFUSED: string;
- export var TIMEOUT: string;
- export var EOF: string;
- export var FILE: string;
- export var NOMEM: string;
- export var DESTRUCTION: string;
- export var BADSTR: string;
- export var BADFLAGS: string;
- export var NONAME: string;
- export var BADHINTS: string;
- export var NOTINITIALIZED: string;
- export var LOADIPHLPAPI: string;
- export var ADDRGETNETWORKPARAMS: string;
- export var CANCELLED: string;
-}
-
-declare module "net" {
- import * as stream from "stream";
- import * as events from "events";
-
- export interface Socket extends stream.Duplex {
- // Extended base methods
- write(buffer: Buffer): boolean;
- write(buffer: Buffer, cb?: Function): boolean;
- write(str: string, cb?: Function): boolean;
- write(str: string, encoding?: string, cb?: Function): boolean;
- write(str: string, encoding?: string, fd?: string): boolean;
-
- connect(port: number, host?: string, connectionListener?: Function): void;
- connect(path: string, connectionListener?: Function): void;
- bufferSize: number;
- setEncoding(encoding?: string): void;
- write(data: any, encoding?: string, callback?: Function): void;
- destroy(): void;
- pause(): Socket;
- resume(): Socket;
- setTimeout(timeout: number, callback?: Function): void;
- setNoDelay(noDelay?: boolean): void;
- setKeepAlive(enable?: boolean, initialDelay?: number): void;
- address(): { port: number; family: string; address: string; };
- unref(): void;
- ref(): void;
-
- remoteAddress: string;
- remoteFamily: string;
- remotePort: number;
- localAddress: string;
- localPort: number;
- bytesRead: number;
- bytesWritten: number;
-
- // Extended base methods
- end(): void;
- end(buffer: Buffer, cb?: Function): void;
- end(str: string, cb?: Function): void;
- end(str: string, encoding?: string, cb?: Function): void;
- end(data?: any, encoding?: string): void;
-
- /**
- * events.EventEmitter
- * 1. close
- * 2. connect
- * 3. data
- * 4. drain
- * 5. end
- * 6. error
- * 7. lookup
- * 8. timeout
- */
- addListener(event: string, listener: Function): this;
- addListener(event: "close", listener: (had_error: boolean) => void): this;
- addListener(event: "connect", listener: () => void): this;
- addListener(event: "data", listener: (data: Buffer) => void): this;
- addListener(event: "drain", listener: () => void): this;
- addListener(event: "end", listener: () => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
- addListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
- addListener(event: "timeout", listener: () => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "close", had_error: boolean): boolean;
- emit(event: "connect"): boolean;
- emit(event: "data", data: Buffer): boolean;
- emit(event: "drain"): boolean;
- emit(event: "end"): boolean;
- emit(event: "error", err: Error): boolean;
- emit(event: "lookup", err: Error, address: string, family: string | number, host: string): boolean;
- emit(event: "timeout"): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "close", listener: (had_error: boolean) => void): this;
- on(event: "connect", listener: () => void): this;
- on(event: "data", listener: (data: Buffer) => void): this;
- on(event: "drain", listener: () => void): this;
- on(event: "end", listener: () => void): this;
- on(event: "error", listener: (err: Error) => void): this;
- on(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
- on(event: "timeout", listener: () => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "close", listener: (had_error: boolean) => void): this;
- once(event: "connect", listener: () => void): this;
- once(event: "data", listener: (data: Buffer) => void): this;
- once(event: "drain", listener: () => void): this;
- once(event: "end", listener: () => void): this;
- once(event: "error", listener: (err: Error) => void): this;
- once(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
- once(event: "timeout", listener: () => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "close", listener: (had_error: boolean) => void): this;
- prependListener(event: "connect", listener: () => void): this;
- prependListener(event: "data", listener: (data: Buffer) => void): this;
- prependListener(event: "drain", listener: () => void): this;
- prependListener(event: "end", listener: () => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
- prependListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
- prependListener(event: "timeout", listener: () => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "close", listener: (had_error: boolean) => void): this;
- prependOnceListener(event: "connect", listener: () => void): this;
- prependOnceListener(event: "data", listener: (data: Buffer) => void): this;
- prependOnceListener(event: "drain", listener: () => void): this;
- prependOnceListener(event: "end", listener: () => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
- prependOnceListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this;
- prependOnceListener(event: "timeout", listener: () => void): this;
- }
-
- export var Socket: {
- new (options?: { fd?: string; type?: string; allowHalfOpen?: boolean; }): Socket;
- };
-
- export interface ListenOptions {
- port?: number;
- host?: string;
- backlog?: number;
- path?: string;
- exclusive?: boolean;
- }
-
- export interface Server extends events.EventEmitter {
- listen(port: number, hostname?: string, backlog?: number, listeningListener?: Function): Server;
- listen(port: number, hostname?: string, listeningListener?: Function): Server;
- listen(port: number, backlog?: number, listeningListener?: Function): Server;
- listen(port: number, listeningListener?: Function): Server;
- listen(path: string, backlog?: number, listeningListener?: Function): Server;
- listen(path: string, listeningListener?: Function): Server;
- listen(options: ListenOptions, listeningListener?: Function): Server;
- listen(handle: any, backlog?: number, listeningListener?: Function): Server;
- listen(handle: any, listeningListener?: Function): Server;
- close(callback?: Function): Server;
- address(): { port: number; family: string; address: string; };
- getConnections(cb: (error: Error, count: number) => void): void;
- ref(): Server;
- unref(): Server;
- maxConnections: number;
- connections: number;
-
- /**
- * events.EventEmitter
- * 1. close
- * 2. connection
- * 3. error
- * 4. listening
- */
- addListener(event: string, listener: Function): this;
- addListener(event: "close", listener: () => void): this;
- addListener(event: "connection", listener: (socket: Socket) => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
- addListener(event: "listening", listener: () => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "close"): boolean;
- emit(event: "connection", socket: Socket): boolean;
- emit(event: "error", err: Error): boolean;
- emit(event: "listening"): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "close", listener: () => void): this;
- on(event: "connection", listener: (socket: Socket) => void): this;
- on(event: "error", listener: (err: Error) => void): this;
- on(event: "listening", listener: () => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "close", listener: () => void): this;
- once(event: "connection", listener: (socket: Socket) => void): this;
- once(event: "error", listener: (err: Error) => void): this;
- once(event: "listening", listener: () => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "close", listener: () => void): this;
- prependListener(event: "connection", listener: (socket: Socket) => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
- prependListener(event: "listening", listener: () => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "close", listener: () => void): this;
- prependOnceListener(event: "connection", listener: (socket: Socket) => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
- prependOnceListener(event: "listening", listener: () => void): this;
- }
- export function createServer(connectionListener?: (socket: Socket) => void): Server;
- export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) => void): Server;
- export function connect(options: { port: number, host?: string, localAddress?: string, localPort?: string, family?: number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
- export function connect(port: number, host?: string, connectionListener?: Function): Socket;
- export function connect(path: string, connectionListener?: Function): Socket;
- export function createConnection(options: { port: number, host?: string, localAddress?: string, localPort?: string, family?: number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket;
- export function createConnection(port: number, host?: string, connectionListener?: Function): Socket;
- export function createConnection(path: string, connectionListener?: Function): Socket;
- export function isIP(input: string): number;
- export function isIPv4(input: string): boolean;
- export function isIPv6(input: string): boolean;
-}
-
-declare module "dgram" {
- import * as events from "events";
-
- interface RemoteInfo {
- address: string;
- family: string;
- port: number;
- }
-
- interface AddressInfo {
- address: string;
- family: string;
- port: number;
- }
-
- interface BindOptions {
- port: number;
- address?: string;
- exclusive?: boolean;
- }
-
- interface SocketOptions {
- type: "udp4" | "udp6";
- reuseAddr?: boolean;
- }
-
- export function createSocket(type: string, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket;
- export function createSocket(options: SocketOptions, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket;
-
- export interface Socket extends events.EventEmitter {
- send(msg: Buffer | String | any[], port: number, address: string, callback?: (error: Error, bytes: number) => void): void;
- send(msg: Buffer | String | any[], offset: number, length: number, port: number, address: string, callback?: (error: Error, bytes: number) => void): void;
- bind(port?: number, address?: string, callback?: () => void): void;
- bind(options: BindOptions, callback?: Function): void;
- close(callback?: any): void;
- address(): AddressInfo;
- setBroadcast(flag: boolean): void;
- setTTL(ttl: number): void;
- setMulticastTTL(ttl: number): void;
- setMulticastLoopback(flag: boolean): void;
- addMembership(multicastAddress: string, multicastInterface?: string): void;
- dropMembership(multicastAddress: string, multicastInterface?: string): void;
- ref(): void;
- unref(): void;
-
- /**
- * events.EventEmitter
- * 1. close
- * 2. error
- * 3. listening
- * 4. message
- **/
- addListener(event: string, listener: Function): this;
- addListener(event: "close", listener: () => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
- addListener(event: "listening", listener: () => void): this;
- addListener(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "close"): boolean;
- emit(event: "error", err: Error): boolean;
- emit(event: "listening"): boolean;
- emit(event: "message", msg: string, rinfo: AddressInfo): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "close", listener: () => void): this;
- on(event: "error", listener: (err: Error) => void): this;
- on(event: "listening", listener: () => void): this;
- on(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "close", listener: () => void): this;
- once(event: "error", listener: (err: Error) => void): this;
- once(event: "listening", listener: () => void): this;
- once(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "close", listener: () => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
- prependListener(event: "listening", listener: () => void): this;
- prependListener(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "close", listener: () => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
- prependOnceListener(event: "listening", listener: () => void): this;
- prependOnceListener(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this;
- }
-}
-
-declare module "fs" {
- import * as stream from "stream";
- import * as events from "events";
-
- interface Stats {
- isFile(): boolean;
- isDirectory(): boolean;
- isBlockDevice(): boolean;
- isCharacterDevice(): boolean;
- isSymbolicLink(): boolean;
- isFIFO(): boolean;
- isSocket(): boolean;
- dev: number;
- ino: number;
- mode: number;
- nlink: number;
- uid: number;
- gid: number;
- rdev: number;
- size: number;
- blksize: number;
- blocks: number;
- atime: Date;
- mtime: Date;
- ctime: Date;
- birthtime: Date;
- }
-
- interface FSWatcher extends events.EventEmitter {
- close(): void;
-
- /**
- * events.EventEmitter
- * 1. change
- * 2. error
- */
- addListener(event: string, listener: Function): this;
- addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
- addListener(event: "error", listener: (code: number, signal: string) => void): this;
-
- on(event: string, listener: Function): this;
- on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
- on(event: "error", listener: (code: number, signal: string) => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
- once(event: "error", listener: (code: number, signal: string) => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
- prependListener(event: "error", listener: (code: number, signal: string) => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this;
- prependOnceListener(event: "error", listener: (code: number, signal: string) => void): this;
- }
-
- export interface ReadStream extends stream.Readable {
- close(): void;
- destroy(): void;
- bytesRead: number;
- path: string | Buffer;
-
- /**
- * events.EventEmitter
- * 1. open
- * 2. close
- */
- addListener(event: string, listener: Function): this;
- addListener(event: "open", listener: (fd: number) => void): this;
- addListener(event: "close", listener: () => void): this;
-
- on(event: string, listener: Function): this;
- on(event: "open", listener: (fd: number) => void): this;
- on(event: "close", listener: () => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "open", listener: (fd: number) => void): this;
- once(event: "close", listener: () => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "open", listener: (fd: number) => void): this;
- prependListener(event: "close", listener: () => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "open", listener: (fd: number) => void): this;
- prependOnceListener(event: "close", listener: () => void): this;
- }
-
- export interface WriteStream extends stream.Writable {
- close(): void;
- bytesWritten: number;
- path: string | Buffer;
-
- /**
- * events.EventEmitter
- * 1. open
- * 2. close
- */
- addListener(event: string, listener: Function): this;
- addListener(event: "open", listener: (fd: number) => void): this;
- addListener(event: "close", listener: () => void): this;
-
- on(event: string, listener: Function): this;
- on(event: "open", listener: (fd: number) => void): this;
- on(event: "close", listener: () => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "open", listener: (fd: number) => void): this;
- once(event: "close", listener: () => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "open", listener: (fd: number) => void): this;
- prependListener(event: "close", listener: () => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "open", listener: (fd: number) => void): this;
- prependOnceListener(event: "close", listener: () => void): this;
- }
-
- /**
- * Asynchronous rename.
- * @param oldPath
- * @param newPath
- * @param callback No arguments other than a possible exception are given to the completion callback.
- */
- export function rename(oldPath: string, newPath: string, callback?: (err?: NodeJS.ErrnoException) => void): void;
- /**
- * Synchronous rename
- * @param oldPath
- * @param newPath
- */
- export function renameSync(oldPath: string, newPath: string): void;
- export function truncate(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function truncate(path: string | Buffer, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function truncateSync(path: string | Buffer, len?: number): void;
- export function ftruncate(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function ftruncate(fd: number, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function ftruncateSync(fd: number, len?: number): void;
- export function chown(path: string | Buffer, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function chownSync(path: string | Buffer, uid: number, gid: number): void;
- export function fchown(fd: number, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function fchownSync(fd: number, uid: number, gid: number): void;
- export function lchown(path: string | Buffer, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function lchownSync(path: string | Buffer, uid: number, gid: number): void;
- export function chmod(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function chmod(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function chmodSync(path: string | Buffer, mode: number): void;
- export function chmodSync(path: string | Buffer, mode: string): void;
- export function fchmod(fd: number, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function fchmod(fd: number, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function fchmodSync(fd: number, mode: number): void;
- export function fchmodSync(fd: number, mode: string): void;
- export function lchmod(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function lchmod(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function lchmodSync(path: string | Buffer, mode: number): void;
- export function lchmodSync(path: string | Buffer, mode: string): void;
- export function stat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void;
- export function lstat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void;
- export function fstat(fd: number, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void;
- export function statSync(path: string | Buffer): Stats;
- export function lstatSync(path: string | Buffer): Stats;
- export function fstatSync(fd: number): Stats;
- export function link(srcpath: string | Buffer, dstpath: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function linkSync(srcpath: string | Buffer, dstpath: string | Buffer): void;
- export function symlink(srcpath: string | Buffer, dstpath: string | Buffer, type?: string, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function symlinkSync(srcpath: string | Buffer, dstpath: string | Buffer, type?: string): void;
- export function readlink(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, linkString: string) => any): void;
- export function readlinkSync(path: string | Buffer): string;
- export function realpath(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void;
- export function realpath(path: string | Buffer, cache: { [path: string]: string }, callback: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void;
- export function realpathSync(path: string | Buffer, cache?: { [path: string]: string }): string;
- /*
- * Asynchronous unlink - deletes the file specified in {path}
- *
- * @param path
- * @param callback No arguments other than a possible exception are given to the completion callback.
- */
- export function unlink(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void;
- /*
- * Synchronous unlink - deletes the file specified in {path}
- *
- * @param path
- */
- export function unlinkSync(path: string | Buffer): void;
- /*
- * Asynchronous rmdir - removes the directory specified in {path}
- *
- * @param path
- * @param callback No arguments other than a possible exception are given to the completion callback.
- */
- export function rmdir(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void;
- /*
- * Synchronous rmdir - removes the directory specified in {path}
- *
- * @param path
- */
- export function rmdirSync(path: string | Buffer): void;
- /*
- * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.
- *
- * @param path
- * @param callback No arguments other than a possible exception are given to the completion callback.
- */
- export function mkdir(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void;
- /*
- * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.
- *
- * @param path
- * @param mode
- * @param callback No arguments other than a possible exception are given to the completion callback.
- */
- export function mkdir(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- /*
- * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.
- *
- * @param path
- * @param mode
- * @param callback No arguments other than a possible exception are given to the completion callback.
- */
- export function mkdir(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void;
- /*
- * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.
- *
- * @param path
- * @param mode
- * @param callback No arguments other than a possible exception are given to the completion callback.
- */
- export function mkdirSync(path: string | Buffer, mode?: number): void;
- /*
- * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.
- *
- * @param path
- * @param mode
- * @param callback No arguments other than a possible exception are given to the completion callback.
- */
- export function mkdirSync(path: string | Buffer, mode?: string): void;
- /*
- * Asynchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
- *
- * @param prefix
- * @param callback The created folder path is passed as a string to the callback's second parameter.
- */
- export function mkdtemp(prefix: string, callback?: (err: NodeJS.ErrnoException, folder: string) => void): void;
- /*
- * Synchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
- *
- * @param prefix
- * @returns Returns the created folder path.
- */
- export function mkdtempSync(prefix: string): string;
- export function readdir(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, files: string[]) => void): void;
- export function readdirSync(path: string | Buffer): string[];
- export function close(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function closeSync(fd: number): void;
- export function open(path: string | Buffer, flags: string | number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void;
- export function open(path: string | Buffer, flags: string | number, mode: number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void;
- export function openSync(path: string | Buffer, flags: string | number, mode?: number): number;
- export function utimes(path: string | Buffer, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function utimes(path: string | Buffer, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function utimesSync(path: string | Buffer, atime: number, mtime: number): void;
- export function utimesSync(path: string | Buffer, atime: Date, mtime: Date): void;
- export function futimes(fd: number, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function futimes(fd: number, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function futimesSync(fd: number, atime: number, mtime: number): void;
- export function futimesSync(fd: number, atime: Date, mtime: Date): void;
- export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void;
- export function fsyncSync(fd: number): void;
- export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void;
- export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void;
- export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void;
- export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void;
- export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void;
- export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number;
- export function writeSync(fd: number, data: any, position?: number, enconding?: string): number;
- export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void;
- export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number;
- /*
- * Asynchronous readFile - Asynchronously reads the entire contents of a file.
- *
- * @param fileName
- * @param encoding
- * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file.
- */
- export function readFile(filename: string, encoding: string, callback: (err: NodeJS.ErrnoException, data: string) => void): void;
- /*
- * Asynchronous readFile - Asynchronously reads the entire contents of a file.
- *
- * @param fileName
- * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer.
- * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file.
- */
- export function readFile(filename: string, options: { encoding: string; flag?: string; }, callback: (err: NodeJS.ErrnoException, data: string) => void): void;
- /*
- * Asynchronous readFile - Asynchronously reads the entire contents of a file.
- *
- * @param fileName
- * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer.
- * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file.
- */
- export function readFile(filename: string, options: { flag?: string; }, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void;
- /*
- * Asynchronous readFile - Asynchronously reads the entire contents of a file.
- *
- * @param fileName
- * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file.
- */
- export function readFile(filename: string, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void;
- /*
- * Synchronous readFile - Synchronously reads the entire contents of a file.
- *
- * @param fileName
- * @param encoding
- */
- export function readFileSync(filename: string, encoding: string): string;
- /*
- * Synchronous readFile - Synchronously reads the entire contents of a file.
- *
- * @param fileName
- * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer.
- */
- export function readFileSync(filename: string, options: { encoding: string; flag?: string; }): string;
- /*
- * Synchronous readFile - Synchronously reads the entire contents of a file.
- *
- * @param fileName
- * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer.
- */
- export function readFileSync(filename: string, options?: { flag?: string; }): Buffer;
- export function writeFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void;
- export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void;
- export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void;
- export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void;
- export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void;
- export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void;
- export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void;
- export function appendFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void;
- export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void;
- export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void;
- export function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): void;
- export function watchFile(filename: string, options: { persistent?: boolean; interval?: number; }, listener: (curr: Stats, prev: Stats) => void): void;
- export function unwatchFile(filename: string, listener?: (curr: Stats, prev: Stats) => void): void;
- export function watch(filename: string, listener?: (event: string, filename: string) => any): FSWatcher;
- export function watch(filename: string, encoding: string, listener?: (event: string, filename: string | Buffer) => any): FSWatcher;
- export function watch(filename: string, options: { persistent?: boolean; recursive?: boolean; encoding?: string }, listener?: (event: string, filename: string | Buffer) => any): FSWatcher;
- export function exists(path: string | Buffer, callback?: (exists: boolean) => void): void;
- export function existsSync(path: string | Buffer): boolean;
-
- export namespace constants {
- // File Access Constants
-
- /** Constant for fs.access(). File is visible to the calling process. */
- export const F_OK: number;
-
- /** Constant for fs.access(). File can be read by the calling process. */
- export const R_OK: number;
-
- /** Constant for fs.access(). File can be written by the calling process. */
- export const W_OK: number;
-
- /** Constant for fs.access(). File can be executed by the calling process. */
- export const X_OK: number;
-
- // File Open Constants
-
- /** Constant for fs.open(). Flag indicating to open a file for read-only access. */
- export const O_RDONLY: number;
-
- /** Constant for fs.open(). Flag indicating to open a file for write-only access. */
- export const O_WRONLY: number;
-
- /** Constant for fs.open(). Flag indicating to open a file for read-write access. */
- export const O_RDWR: number;
-
- /** Constant for fs.open(). Flag indicating to create the file if it does not already exist. */
- export const O_CREAT: number;
-
- /** Constant for fs.open(). Flag indicating that opening a file should fail if the O_CREAT flag is set and the file already exists. */
- export const O_EXCL: number;
-
- /** Constant for fs.open(). Flag indicating that if path identifies a terminal device, opening the path shall not cause that terminal to become the controlling terminal for the process (if the process does not already have one). */
- export const O_NOCTTY: number;
-
- /** Constant for fs.open(). Flag indicating that if the file exists and is a regular file, and the file is opened successfully for write access, its length shall be truncated to zero. */
- export const O_TRUNC: number;
-
- /** Constant for fs.open(). Flag indicating that data will be appended to the end of the file. */
- export const O_APPEND: number;
-
- /** Constant for fs.open(). Flag indicating that the open should fail if the path is not a directory. */
- export const O_DIRECTORY: number;
-
- /** Constant for fs.open(). Flag indicating reading accesses to the file system will no longer result in an update to the atime information associated with the file. This flag is available on Linux operating systems only. */
- export const O_NOATIME: number;
-
- /** Constant for fs.open(). Flag indicating that the open should fail if the path is a symbolic link. */
- export const O_NOFOLLOW: number;
-
- /** Constant for fs.open(). Flag indicating that the file is opened for synchronous I/O. */
- export const O_SYNC: number;
-
- /** Constant for fs.open(). Flag indicating to open the symbolic link itself rather than the resource it is pointing to. */
- export const O_SYMLINK: number;
-
- /** Constant for fs.open(). When set, an attempt will be made to minimize caching effects of file I/O. */
- export const O_DIRECT: number;
-
- /** Constant for fs.open(). Flag indicating to open the file in nonblocking mode when possible. */
- export const O_NONBLOCK: number;
-
- // File Type Constants
-
- /** Constant for fs.Stats mode property for determining a file's type. Bit mask used to extract the file type code. */
- export const S_IFMT: number;
-
- /** Constant for fs.Stats mode property for determining a file's type. File type constant for a regular file. */
- export const S_IFREG: number;
-
- /** Constant for fs.Stats mode property for determining a file's type. File type constant for a directory. */
- export const S_IFDIR: number;
-
- /** Constant for fs.Stats mode property for determining a file's type. File type constant for a character-oriented device file. */
- export const S_IFCHR: number;
-
- /** Constant for fs.Stats mode property for determining a file's type. File type constant for a block-oriented device file. */
- export const S_IFBLK: number;
-
- /** Constant for fs.Stats mode property for determining a file's type. File type constant for a FIFO/pipe. */
- export const S_IFIFO: number;
-
- /** Constant for fs.Stats mode property for determining a file's type. File type constant for a symbolic link. */
- export const S_IFLNK: number;
-
- /** Constant for fs.Stats mode property for determining a file's type. File type constant for a socket. */
- export const S_IFSOCK: number;
-
- // File Mode Constants
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by owner. */
- export const S_IRWXU: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by owner. */
- export const S_IRUSR: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by owner. */
- export const S_IWUSR: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by owner. */
- export const S_IXUSR: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by group. */
- export const S_IRWXG: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by group. */
- export const S_IRGRP: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by group. */
- export const S_IWGRP: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by group. */
- export const S_IXGRP: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by others. */
- export const S_IRWXO: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by others. */
- export const S_IROTH: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by others. */
- export const S_IWOTH: number;
-
- /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by others. */
- export const S_IXOTH: number;
- }
-
- /** Tests a user's permissions for the file specified by path. */
- export function access(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void;
- export function access(path: string | Buffer, mode: number, callback: (err: NodeJS.ErrnoException) => void): void;
- /** Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise. */
- export function accessSync(path: string | Buffer, mode?: number): void;
- export function createReadStream(path: string | Buffer, options?: {
- flags?: string;
- encoding?: string;
- fd?: number;
- mode?: number;
- autoClose?: boolean;
- start?: number;
- end?: number;
- }): ReadStream;
- export function createWriteStream(path: string | Buffer, options?: {
- flags?: string;
- encoding?: string;
- fd?: number;
- mode?: number;
- autoClose?: boolean;
- start?: number;
- }): WriteStream;
- export function fdatasync(fd: number, callback: Function): void;
- export function fdatasyncSync(fd: number): void;
-}
-
-declare module "path" {
-
- /**
- * A parsed path object generated by path.parse() or consumed by path.format().
- */
- export interface ParsedPath {
- /**
- * The root of the path such as '/' or 'c:\'
- */
- root: string;
- /**
- * The full directory path such as '/home/user/dir' or 'c:\path\dir'
- */
- dir: string;
- /**
- * The file name including extension (if any) such as 'index.html'
- */
- base: string;
- /**
- * The file extension (if any) such as '.html'
- */
- ext: string;
- /**
- * The file name without extension (if any) such as 'index'
- */
- name: string;
- }
-
- /**
- * Normalize a string path, reducing '..' and '.' parts.
- * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.
- *
- * @param p string path to normalize.
- */
- export function normalize(p: string): string;
- /**
- * Join all arguments together and normalize the resulting path.
- * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.
- *
- * @param paths string paths to join.
- */
- export function join(...paths: any[]): string;
- /**
- * Join all arguments together and normalize the resulting path.
- * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.
- *
- * @param paths string paths to join.
- */
- export function join(...paths: string[]): string;
- /**
- * The right-most parameter is considered {to}. Other parameters are considered an array of {from}.
- *
- * Starting from leftmost {from} paramter, resolves {to} to an absolute path.
- *
- * If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.
- *
- * @param pathSegments string paths to join. Non-string arguments are ignored.
- */
- export function resolve(...pathSegments: any[]): string;
- /**
- * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.
- *
- * @param path path to test.
- */
- export function isAbsolute(path: string): boolean;
- /**
- * Solve the relative path from {from} to {to}.
- * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.
- *
- * @param from
- * @param to
- */
- export function relative(from: string, to: string): string;
- /**
- * Return the directory name of a path. Similar to the Unix dirname command.
- *
- * @param p the path to evaluate.
- */
- export function dirname(p: string): string;
- /**
- * Return the last portion of a path. Similar to the Unix basename command.
- * Often used to extract the file name from a fully qualified path.
- *
- * @param p the path to evaluate.
- * @param ext optionally, an extension to remove from the result.
- */
- export function basename(p: string, ext?: string): string;
- /**
- * Return the extension of the path, from the last '.' to end of string in the last portion of the path.
- * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string
- *
- * @param p the path to evaluate.
- */
- export function extname(p: string): string;
- /**
- * The platform-specific file separator. '\\' or '/'.
- */
- export var sep: string;
- /**
- * The platform-specific file delimiter. ';' or ':'.
- */
- export var delimiter: string;
- /**
- * Returns an object from a path string - the opposite of format().
- *
- * @param pathString path to evaluate.
- */
- export function parse(pathString: string): ParsedPath;
- /**
- * Returns a path string from an object - the opposite of parse().
- *
- * @param pathString path to evaluate.
- */
- export function format(pathObject: ParsedPath): string;
-
- export module posix {
- export function normalize(p: string): string;
- export function join(...paths: any[]): string;
- export function resolve(...pathSegments: any[]): string;
- export function isAbsolute(p: string): boolean;
- export function relative(from: string, to: string): string;
- export function dirname(p: string): string;
- export function basename(p: string, ext?: string): string;
- export function extname(p: string): string;
- export var sep: string;
- export var delimiter: string;
- export function parse(p: string): ParsedPath;
- export function format(pP: ParsedPath): string;
- }
-
- export module win32 {
- export function normalize(p: string): string;
- export function join(...paths: any[]): string;
- export function resolve(...pathSegments: any[]): string;
- export function isAbsolute(p: string): boolean;
- export function relative(from: string, to: string): string;
- export function dirname(p: string): string;
- export function basename(p: string, ext?: string): string;
- export function extname(p: string): string;
- export var sep: string;
- export var delimiter: string;
- export function parse(p: string): ParsedPath;
- export function format(pP: ParsedPath): string;
- }
-}
-
-declare module "string_decoder" {
- export interface NodeStringDecoder {
- write(buffer: Buffer): string;
- end(buffer?: Buffer): string;
- }
- export var StringDecoder: {
- new (encoding?: string): NodeStringDecoder;
- };
-}
-
-declare module "tls" {
- import * as crypto from "crypto";
- import * as net from "net";
- import * as stream from "stream";
-
- var CLIENT_RENEG_LIMIT: number;
- var CLIENT_RENEG_WINDOW: number;
-
- export interface Certificate {
- /**
- * Country code.
- */
- C: string;
- /**
- * Street.
- */
- ST: string;
- /**
- * Locality.
- */
- L: string;
- /**
- * Organization.
- */
- O: string;
- /**
- * Organizational unit.
- */
- OU: string;
- /**
- * Common name.
- */
- CN: string;
- }
-
- export interface CipherNameAndProtocol {
- /**
- * The cipher name.
- */
- name: string;
- /**
- * SSL/TLS protocol version.
- */
- version: string;
- }
-
- export class TLSSocket extends stream.Duplex {
- /**
- * Construct a new tls.TLSSocket object from an existing TCP socket.
- */
- constructor(socket:net.Socket, options?: {
- /**
- * An optional TLS context object from tls.createSecureContext()
- */
- secureContext?: SecureContext,
- /**
- * If true the TLS socket will be instantiated in server-mode.
- * Defaults to false.
- */
- isServer?: boolean,
- /**
- * An optional net.Server instance.
- */
- server?: net.Server,
- /**
- * If true the server will request a certificate from clients that
- * connect and attempt to verify that certificate. Defaults to
- * false.
- */
- requestCert?: boolean,
- /**
- * If true the server will reject any connection which is not
- * authorized with the list of supplied CAs. This option only has an
- * effect if requestCert is true. Defaults to false.
- */
- rejectUnauthorized?: boolean,
- /**
- * An array of strings or a Buffer naming possible NPN protocols.
- * (Protocols should be ordered by their priority.)
- */
- NPNProtocols?: string[] | Buffer,
- /**
- * An array of strings or a Buffer naming possible ALPN protocols.
- * (Protocols should be ordered by their priority.) When the server
- * receives both NPN and ALPN extensions from the client, ALPN takes
- * precedence over NPN and the server does not send an NPN extension
- * to the client.
- */
- ALPNProtocols?: string[] | Buffer,
- /**
- * SNICallback(servername, cb) <Function> A function that will be
- * called if the client supports SNI TLS extension. Two arguments
- * will be passed when called: servername and cb. SNICallback should
- * invoke cb(null, ctx), where ctx is a SecureContext instance.
- * (tls.createSecureContext(...) can be used to get a proper
- * SecureContext.) If SNICallback wasn't provided the default callback
- * with high-level API will be used (see below).
- */
- SNICallback?: Function,
- /**
- * An optional Buffer instance containing a TLS session.
- */
- session?: Buffer,
- /**
- * If true, specifies that the OCSP status request extension will be
- * added to the client hello and an 'OCSPResponse' event will be
- * emitted on the socket before establishing a secure communication
- */
- requestOCSP?: boolean
- });
- /**
- * Returns the bound address, the address family name and port of the underlying socket as reported by
- * the operating system.
- * @returns {any} - An object with three properties, e.g. { port: 12346, family: 'IPv4', address: '127.0.0.1' }.
- */
- address(): { port: number; family: string; address: string };
- /**
- * A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false.
- */
- authorized: boolean;
- /**
- * The reason why the peer's certificate has not been verified.
- * This property becomes available only when tlsSocket.authorized === false.
- */
- authorizationError: Error;
- /**
- * Static boolean value, always true.
- * May be used to distinguish TLS sockets from regular ones.
- */
- encrypted: boolean;
- /**
- * Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection.
- * @returns {CipherNameAndProtocol} - Returns an object representing the cipher name
- * and the SSL/TLS protocol version of the current connection.
- */
- getCipher(): CipherNameAndProtocol;
- /**
- * Returns an object representing the peer's certificate.
- * The returned object has some properties corresponding to the field of the certificate.
- * If detailed argument is true the full chain with issuer property will be returned,
- * if false only the top certificate without issuer property.
- * If the peer does not provide a certificate, it returns null or an empty object.
- * @param {boolean} detailed - If true; the full chain with issuer property will be returned.
- * @returns {any} - An object representing the peer's certificate.
- */
- getPeerCertificate(detailed?: boolean): {
- subject: Certificate;
- issuerInfo: Certificate;
- issuer: Certificate;
- raw: any;
- valid_from: string;
- valid_to: string;
- fingerprint: string;
- serialNumber: string;
- };
- /**
- * Could be used to speed up handshake establishment when reconnecting to the server.
- * @returns {any} - ASN.1 encoded TLS session or undefined if none was negotiated.
- */
- getSession(): any;
- /**
- * NOTE: Works only with client TLS sockets.
- * Useful only for debugging, for session reuse provide session option to tls.connect().
- * @returns {any} - TLS session ticket or undefined if none was negotiated.
- */
- getTLSTicket(): any;
- /**
- * The string representation of the local IP address.
- */
- localAddress: string;
- /**
- * The numeric representation of the local port.
- */
- localPort: string;
- /**
- * The string representation of the remote IP address.
- * For example, '74.125.127.100' or '2001:4860:a005::68'.
- */
- remoteAddress: string;
- /**
- * The string representation of the remote IP family. 'IPv4' or 'IPv6'.
- */
- remoteFamily: string;
- /**
- * The numeric representation of the remote port. For example, 443.
- */
- remotePort: number;
- /**
- * Initiate TLS renegotiation process.
- *
- * NOTE: Can be used to request peer's certificate after the secure connection has been established.
- * ANOTHER NOTE: When running as the server, socket will be destroyed with an error after handshakeTimeout timeout.
- * @param {TlsOptions} options - The options may contain the following fields: rejectUnauthorized,
- * requestCert (See tls.createServer() for details).
- * @param {Function} callback - callback(err) will be executed with null as err, once the renegotiation
- * is successfully completed.
- */
- renegotiate(options: TlsOptions, callback: (err: Error) => any): any;
- /**
- * Set maximum TLS fragment size (default and maximum value is: 16384, minimum is: 512).
- * Smaller fragment size decreases buffering latency on the client: large fragments are buffered by
- * the TLS layer until the entire fragment is received and its integrity is verified;
- * large fragments can span multiple roundtrips, and their processing can be delayed due to packet
- * loss or reordering. However, smaller fragments add extra TLS framing bytes and CPU overhead,
- * which may decrease overall server throughput.
- * @param {number} size - TLS fragment size (default and maximum value is: 16384, minimum is: 512).
- * @returns {boolean} - Returns true on success, false otherwise.
- */
- setMaxSendFragment(size: number): boolean;
-
- /**
- * events.EventEmitter
- * 1. OCSPResponse
- * 2. secureConnect
- **/
- addListener(event: string, listener: Function): this;
- addListener(event: "OCSPResponse", listener: (response: Buffer) => void): this;
- addListener(event: "secureConnect", listener: () => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "OCSPResponse", response: Buffer): boolean;
- emit(event: "secureConnect"): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "OCSPResponse", listener: (response: Buffer) => void): this;
- on(event: "secureConnect", listener: () => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "OCSPResponse", listener: (response: Buffer) => void): this;
- once(event: "secureConnect", listener: () => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "OCSPResponse", listener: (response: Buffer) => void): this;
- prependListener(event: "secureConnect", listener: () => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "OCSPResponse", listener: (response: Buffer) => void): this;
- prependOnceListener(event: "secureConnect", listener: () => void): this;
- }
-
- export interface TlsOptions {
- host?: string;
- port?: number;
- pfx?: string | Buffer[];
- key?: string | string[] | Buffer | any[];
- passphrase?: string;
- cert?: string | string[] | Buffer | Buffer[];
- ca?: string | string[] | Buffer | Buffer[];
- crl?: string | string[];
- ciphers?: string;
- honorCipherOrder?: boolean;
- requestCert?: boolean;
- rejectUnauthorized?: boolean;
- NPNProtocols?: string[] | Buffer;
- SNICallback?: (servername: string, cb: (err: Error, ctx: SecureContext) => any) => any;
- ecdhCurve?: string;
- dhparam?: string | Buffer;
- handshakeTimeout?: number;
- ALPNProtocols?: string[] | Buffer;
- sessionTimeout?: number;
- ticketKeys?: any;
- sessionIdContext?: string;
- secureProtocol?: string;
- }
-
- export interface ConnectionOptions {
- host?: string;
- port?: number;
- socket?: net.Socket;
- pfx?: string | Buffer
- key?: string | string[] | Buffer | Buffer[];
- passphrase?: string;
- cert?: string | string[] | Buffer | Buffer[];
- ca?: string | Buffer | (string | Buffer)[];
- rejectUnauthorized?: boolean;
- NPNProtocols?: (string | Buffer)[];
- servername?: string;
- path?: string;
- ALPNProtocols?: (string | Buffer)[];
- checkServerIdentity?: (servername: string, cert: string | Buffer | (string | Buffer)[]) => any;
- secureProtocol?: string;
- secureContext?: Object;
- session?: Buffer;
- minDHSize?: number;
- }
-
- export interface Server extends net.Server {
- close(): Server;
- address(): { port: number; family: string; address: string; };
- addContext(hostName: string, credentials: {
- key: string;
- cert: string;
- ca: string;
- }): void;
- maxConnections: number;
- connections: number;
-
- /**
- * events.EventEmitter
- * 1. tlsClientError
- * 2. newSession
- * 3. OCSPRequest
- * 4. resumeSession
- * 5. secureConnection
- **/
- addListener(event: string, listener: Function): this;
- addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
- addListener(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this;
- addListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this;
- addListener(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this;
- addListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "tlsClientError", err: Error, tlsSocket: TLSSocket): boolean;
- emit(event: "newSession", sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void): boolean;
- emit(event: "OCSPRequest", certificate: Buffer, issuer: Buffer, callback: Function): boolean;
- emit(event: "resumeSession", sessionId: any, callback: (err: Error, sessionData: any) => void): boolean;
- emit(event: "secureConnection", tlsSocket: TLSSocket): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
- on(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this;
- on(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this;
- on(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this;
- on(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
- once(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this;
- once(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this;
- once(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this;
- once(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
- prependListener(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this;
- prependListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this;
- prependListener(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this;
- prependListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this;
- prependOnceListener(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this;
- prependOnceListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this;
- prependOnceListener(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this;
- prependOnceListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this;
- }
-
- export interface ClearTextStream extends stream.Duplex {
- authorized: boolean;
- authorizationError: Error;
- getPeerCertificate(): any;
- getCipher: {
- name: string;
- version: string;
- };
- address: {
- port: number;
- family: string;
- address: string;
- };
- remoteAddress: string;
- remotePort: number;
- }
-
- export interface SecurePair {
- encrypted: any;
- cleartext: any;
- }
-
- export interface SecureContextOptions {
- pfx?: string | Buffer;
- key?: string | Buffer;
- passphrase?: string;
- cert?: string | Buffer;
- ca?: string | Buffer;
- crl?: string | string[]
- ciphers?: string;
- honorCipherOrder?: boolean;
- }
-
- export interface SecureContext {
- context: any;
- }
-
- export function createServer(options: TlsOptions, secureConnectionListener?: (cleartextStream: ClearTextStream) => void): Server;
- export function connect(options: ConnectionOptions, secureConnectionListener?: () => void): ClearTextStream;
- export function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): ClearTextStream;
- export function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): ClearTextStream;
- export function createSecurePair(credentials?: crypto.Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair;
- export function createSecureContext(details: SecureContextOptions): SecureContext;
-}
-
-declare module "crypto" {
- export interface Certificate {
- exportChallenge(spkac: string | Buffer): Buffer;
- exportPublicKey(spkac: string | Buffer): Buffer;
- verifySpkac(spkac: Buffer): boolean;
- }
- export var Certificate: {
- new (): Certificate;
- (): Certificate;
- }
-
- export var fips: boolean;
-
- export interface CredentialDetails {
- pfx: string;
- key: string;
- passphrase: string;
- cert: string;
- ca: string | string[];
- crl: string | string[];
- ciphers: string;
- }
- export interface Credentials { context?: any; }
- export function createCredentials(details: CredentialDetails): Credentials;
- export function createHash(algorithm: string): Hash;
- export function createHmac(algorithm: string, key: string | Buffer): Hmac;
-
- type Utf8AsciiLatin1Encoding = "utf8" | "ascii" | "latin1";
- type HexBase64Latin1Encoding = "latin1" | "hex" | "base64";
- type Utf8AsciiBinaryEncoding = "utf8" | "ascii" | "binary";
- type HexBase64BinaryEncoding = "binary" | "base64" | "hex";
- type ECDHKeyFormat = "compressed" | "uncompressed" | "hybrid";
-
- export interface Hash extends NodeJS.ReadWriteStream {
- update(data: string | Buffer): Hash;
- update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Hash;
- digest(): Buffer;
- digest(encoding: HexBase64Latin1Encoding): string;
- }
- export interface Hmac extends NodeJS.ReadWriteStream {
- update(data: string | Buffer): Hmac;
- update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Hmac;
- digest(): Buffer;
- digest(encoding: HexBase64Latin1Encoding): string;
- }
- export function createCipher(algorithm: string, password: any): Cipher;
- export function createCipheriv(algorithm: string, key: any, iv: any): Cipher;
- export interface Cipher extends NodeJS.ReadWriteStream {
- update(data: Buffer): Buffer;
- update(data: string, input_encoding: Utf8AsciiBinaryEncoding): Buffer;
- update(data: Buffer, input_encoding: any, output_encoding: HexBase64BinaryEncoding): string;
- update(data: string, input_encoding: Utf8AsciiBinaryEncoding, output_encoding: HexBase64BinaryEncoding): string;
- final(): Buffer;
- final(output_encoding: string): string;
- setAutoPadding(auto_padding?: boolean): void;
- getAuthTag(): Buffer;
- setAAD(buffer: Buffer): void;
- }
- export function createDecipher(algorithm: string, password: any): Decipher;
- export function createDecipheriv(algorithm: string, key: any, iv: any): Decipher;
- export interface Decipher extends NodeJS.ReadWriteStream {
- update(data: Buffer): Buffer;
- update(data: string, input_encoding: HexBase64BinaryEncoding): Buffer;
- update(data: Buffer, input_encoding: any, output_encoding: Utf8AsciiBinaryEncoding): string;
- update(data: string, input_encoding: HexBase64BinaryEncoding, output_encoding: Utf8AsciiBinaryEncoding): string;
- final(): Buffer;
- final(output_encoding: string): string;
- setAutoPadding(auto_padding?: boolean): void;
- setAuthTag(tag: Buffer): void;
- setAAD(buffer: Buffer): void;
- }
- export function createSign(algorithm: string): Signer;
- export interface Signer extends NodeJS.WritableStream {
- update(data: string | Buffer): Signer;
- update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Signer;
- sign(private_key: string | { key: string; passphrase: string }): Buffer;
- sign(private_key: string | { key: string; passphrase: string }, output_format: HexBase64Latin1Encoding): string;
- }
- export function createVerify(algorith: string): Verify;
- export interface Verify extends NodeJS.WritableStream {
- update(data: string | Buffer): Verify;
- update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Verify;
- verify(object: string, signature: Buffer): boolean;
- verify(object: string, signature: string, signature_format: HexBase64Latin1Encoding): boolean;
- }
- export function createDiffieHellman(prime_length: number, generator?: number): DiffieHellman;
- export function createDiffieHellman(prime: Buffer): DiffieHellman;
- export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding): DiffieHellman;
- export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: number | Buffer): DiffieHellman;
- export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: string, generator_encoding: HexBase64Latin1Encoding): DiffieHellman;
- export interface DiffieHellman {
- generateKeys(): Buffer;
- generateKeys(encoding: HexBase64Latin1Encoding): string;
- computeSecret(other_public_key: Buffer): Buffer;
- computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer;
- computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string;
- getPrime(): Buffer;
- getPrime(encoding: HexBase64Latin1Encoding): string;
- getGenerator(): Buffer;
- getGenerator(encoding: HexBase64Latin1Encoding): string;
- getPublicKey(): Buffer;
- getPublicKey(encoding: HexBase64Latin1Encoding): string;
- getPrivateKey(): Buffer;
- getPrivateKey(encoding: HexBase64Latin1Encoding): string;
- setPublicKey(public_key: Buffer): void;
- setPublicKey(public_key: string, encoding: string): void;
- setPrivateKey(private_key: Buffer): void;
- setPrivateKey(private_key: string, encoding: string): void;
- verifyError: number;
- }
- export function getDiffieHellman(group_name: string): DiffieHellman;
- export function pbkdf2(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string, callback: (err: Error, derivedKey: Buffer) => any): void;
- export function pbkdf2Sync(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string): Buffer;
- export function randomBytes(size: number): Buffer;
- export function randomBytes(size: number, callback: (err: Error, buf: Buffer) => void): void;
- export function pseudoRandomBytes(size: number): Buffer;
- export function pseudoRandomBytes(size: number, callback: (err: Error, buf: Buffer) => void): void;
- export interface RsaPublicKey {
- key: string;
- padding?: number;
- }
- export interface RsaPrivateKey {
- key: string;
- passphrase?: string,
- padding?: number;
- }
- export function publicEncrypt(public_key: string | RsaPublicKey, buffer: Buffer): Buffer
- export function privateDecrypt(private_key: string | RsaPrivateKey, buffer: Buffer): Buffer
- export function privateEncrypt(private_key: string | RsaPrivateKey, buffer: Buffer): Buffer
- export function publicDecrypt(public_key: string | RsaPublicKey, buffer: Buffer): Buffer
- export function getCiphers(): string[];
- export function getCurves(): string[];
- export function getHashes(): string[];
- export interface ECDH {
- generateKeys(): Buffer;
- generateKeys(encoding: HexBase64Latin1Encoding): string;
- generateKeys(encoding: HexBase64Latin1Encoding, format: ECDHKeyFormat): string;
- computeSecret(other_public_key: Buffer): Buffer;
- computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer;
- computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string;
- getPrivateKey(): Buffer;
- getPrivateKey(encoding: HexBase64Latin1Encoding): string;
- getPublicKey(): Buffer;
- getPublicKey(encoding: HexBase64Latin1Encoding): string;
- getPublicKey(encoding: HexBase64Latin1Encoding, format: ECDHKeyFormat): string;
- setPrivateKey(private_key: Buffer): void;
- setPrivateKey(private_key: string, encoding: HexBase64Latin1Encoding): void;
- }
- export function createECDH(curve_name: string): ECDH;
- export function timingSafeEqual(a: Buffer, b: Buffer): boolean;
- export var DEFAULT_ENCODING: string;
-}
-
-declare module "stream" {
- import * as events from "events";
-
- class internal extends events.EventEmitter {
- pipe<T extends NodeJS.WritableStream>(destination: T, options?: { end?: boolean; }): T;
- }
- namespace internal {
-
- export class Stream extends internal { }
-
- export interface ReadableOptions {
- highWaterMark?: number;
- encoding?: string;
- objectMode?: boolean;
- read?: (size?: number) => any;
- }
-
- export class Readable extends events.EventEmitter implements NodeJS.ReadableStream {
- readable: boolean;
- constructor(opts?: ReadableOptions);
- protected _read(size: number): void;
- read(size?: number): any;
- setEncoding(encoding: string): void;
- pause(): Readable;
- resume(): Readable;
- pipe<T extends NodeJS.WritableStream>(destination: T, options?: { end?: boolean; }): T;
- unpipe<T extends NodeJS.WritableStream>(destination?: T): void;
- unshift(chunk: any): void;
- wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream;
- push(chunk: any, encoding?: string): boolean;
-
- /**
- * Event emitter
- * The defined events on documents including:
- * 1. close
- * 2. data
- * 3. end
- * 4. readable
- * 5. error
- **/
- addListener(event: string, listener: Function): this;
- addListener(event: string, listener: Function): this;
- addListener(event: "close", listener: () => void): this;
- addListener(event: "data", listener: (chunk: Buffer | string) => void): this;
- addListener(event: "end", listener: () => void): this;
- addListener(event: "readable", listener: () => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "close"): boolean;
- emit(event: "data", chunk: Buffer | string): boolean;
- emit(event: "end"): boolean;
- emit(event: "readable"): boolean;
- emit(event: "error", err: Error): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "close", listener: () => void): this;
- on(event: "data", listener: (chunk: Buffer | string) => void): this;
- on(event: "end", listener: () => void): this;
- on(event: "readable", listener: () => void): this;
- on(event: "error", listener: (err: Error) => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "close", listener: () => void): this;
- once(event: "data", listener: (chunk: Buffer | string) => void): this;
- once(event: "end", listener: () => void): this;
- once(event: "readable", listener: () => void): this;
- once(event: "error", listener: (err: Error) => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "close", listener: () => void): this;
- prependListener(event: "data", listener: (chunk: Buffer | string) => void): this;
- prependListener(event: "end", listener: () => void): this;
- prependListener(event: "readable", listener: () => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "close", listener: () => void): this;
- prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this;
- prependOnceListener(event: "end", listener: () => void): this;
- prependOnceListener(event: "readable", listener: () => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
-
- removeListener(event: string, listener: Function): this;
- removeListener(event: "close", listener: () => void): this;
- removeListener(event: "data", listener: (chunk: Buffer | string) => void): this;
- removeListener(event: "end", listener: () => void): this;
- removeListener(event: "readable", listener: () => void): this;
- removeListener(event: "error", listener: (err: Error) => void): this;
- }
-
- export interface WritableOptions {
- highWaterMark?: number;
- decodeStrings?: boolean;
- objectMode?: boolean;
- write?: (chunk: string | Buffer, encoding: string, callback: Function) => any;
- writev?: (chunks: { chunk: string | Buffer, encoding: string }[], callback: Function) => any;
- }
-
- export class Writable extends events.EventEmitter implements NodeJS.WritableStream {
- writable: boolean;
- constructor(opts?: WritableOptions);
- protected _write(chunk: any, encoding: string, callback: Function): void;
- write(chunk: any, cb?: Function): boolean;
- write(chunk: any, encoding?: string, cb?: Function): boolean;
- end(): void;
- end(chunk: any, cb?: Function): void;
- end(chunk: any, encoding?: string, cb?: Function): void;
-
- /**
- * Event emitter
- * The defined events on documents including:
- * 1. close
- * 2. drain
- * 3. error
- * 4. finish
- * 5. pipe
- * 6. unpipe
- **/
- addListener(event: string, listener: Function): this;
- addListener(event: "close", listener: () => void): this;
- addListener(event: "drain", listener: () => void): this;
- addListener(event: "error", listener: (err: Error) => void): this;
- addListener(event: "finish", listener: () => void): this;
- addListener(event: "pipe", listener: (src: Readable) => void): this;
- addListener(event: "unpipe", listener: (src: Readable) => void): this;
-
- emit(event: string, ...args: any[]): boolean;
- emit(event: "close"): boolean;
- emit(event: "drain", chunk: Buffer | string): boolean;
- emit(event: "error", err: Error): boolean;
- emit(event: "finish"): boolean;
- emit(event: "pipe", src: Readable): boolean;
- emit(event: "unpipe", src: Readable): boolean;
-
- on(event: string, listener: Function): this;
- on(event: "close", listener: () => void): this;
- on(event: "drain", listener: () => void): this;
- on(event: "error", listener: (err: Error) => void): this;
- on(event: "finish", listener: () => void): this;
- on(event: "pipe", listener: (src: Readable) => void): this;
- on(event: "unpipe", listener: (src: Readable) => void): this;
-
- once(event: string, listener: Function): this;
- once(event: "close", listener: () => void): this;
- once(event: "drain", listener: () => void): this;
- once(event: "error", listener: (err: Error) => void): this;
- once(event: "finish", listener: () => void): this;
- once(event: "pipe", listener: (src: Readable) => void): this;
- once(event: "unpipe", listener: (src: Readable) => void): this;
-
- prependListener(event: string, listener: Function): this;
- prependListener(event: "close", listener: () => void): this;
- prependListener(event: "drain", listener: () => void): this;
- prependListener(event: "error", listener: (err: Error) => void): this;
- prependListener(event: "finish", listener: () => void): this;
- prependListener(event: "pipe", listener: (src: Readable) => void): this;
- prependListener(event: "unpipe", listener: (src: Readable) => void): this;
-
- prependOnceListener(event: string, listener: Function): this;
- prependOnceListener(event: "close", listener: () => void): this;
- prependOnceListener(event: "drain", listener: () => void): this;
- prependOnceListener(event: "error", listener: (err: Error) => void): this;
- prependOnceListener(event: "finish", listener: () => void): this;
- prependOnceListener(event: "pipe", listener: (src: Readable) => void): this;
- prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this;
-
- removeListener(event: string, listener: Function): this;
- removeListener(event: "close", listener: () => void): this;
- removeListener(event: "drain", listener: () => void): this;
- removeListener(event: "error", listener: (err: Error) => void): this;
- removeListener(event: "finish", listener: () => void): this;
- removeListener(event: "pipe", listener: (src: Readable) => void): this;
- removeListener(event: "unpipe", listener: (src: Readable) => void): this;
- }
-
- export interface DuplexOptions extends ReadableOptions, WritableOptions {
- allowHalfOpen?: boolean;
- readableObjectMode?: boolean;
- writableObjectMode?: boolean;
- }
-
- // Note: Duplex extends both Readable and Writable.
- export class Duplex extends Readable implements NodeJS.ReadWriteStream {
- // Readable
- pause(): Duplex;
- resume(): Duplex;
- // Writeable
- writable: boolean;
- constructor(opts?: DuplexOptions);
- protected _write(chunk: any, encoding: string, callback: Function): void;
- write(chunk: any, cb?: Function): boolean;
- write(chunk: any, encoding?: string, cb?: Function): boolean;
- end(): void;
- end(chunk: any, cb?: Function): void;
- end(chunk: any, encoding?: string, cb?: Function): void;
- }
-
- export interface TransformOptions extends DuplexOptions {
- transform?: (chunk: string | Buffer, encoding: string, callback: Function) => any;
- flush?: (callback: Function) => any;
- }
-
- // Note: Transform lacks the _read and _write methods of Readable/Writable.
- export class Transform extends events.EventEmitter implements NodeJS.ReadWriteStream {
- readable: boolean;
- writable: boolean;
- constructor(opts?: TransformOptions);
- protected _transform(chunk: any, encoding: string, callback: Function): void;
- protected _flush(callback: Function): void;
- read(size?: number): any;
- setEncoding(encoding: string): void;
- pause(): Transform;
- resume(): Transform;
- pipe<T extends NodeJS.WritableStream>(destination: T, options?: { end?: boolean; }): T;
- unpipe<T extends NodeJS.WritableStream>(destination?: T): void;
- unshift(chunk: any): void;
- wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream;
- push(chunk: any, encoding?: string): boolean;
- write(chunk: any, cb?: Function): boolean;
- write(chunk: any, encoding?: string, cb?: Function): boolean;
- end(): void;
- end(chunk: any, cb?: Function): void;
- end(chunk: any, encoding?: string, cb?: Function): void;
- }
-
- export class PassThrough extends Transform { }
- }
-
- export = internal;
-}
-
-declare module "util" {
- export interface InspectOptions {
- showHidden?: boolean;
- depth?: number;
- colors?: boolean;
- customInspect?: boolean;
- }
-
- export function format(format: any, ...param: any[]): string;
- export function debug(string: string): void;
- export function error(...param: any[]): void;
- export function puts(...param: any[]): void;
- export function print(...param: any[]): void;
- export function log(string: string): void;
- export function inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string;
- export function inspect(object: any, options: InspectOptions): string;
- export function isArray(object: any): boolean;
- export function isRegExp(object: any): boolean;
- export function isDate(object: any): boolean;
- export function isError(object: any): boolean;
- export function inherits(constructor: any, superConstructor: any): void;
- export function debuglog(key: string): (msg: string, ...param: any[]) => void;
- export function isBoolean(object: any): boolean;
- export function isBuffer(object: any): boolean;
- export function isFunction(object: any): boolean;
- export function isNull(object: any): boolean;
- export function isNullOrUndefined(object: any): boolean;
- export function isNumber(object: any): boolean;
- export function isObject(object: any): boolean;
- export function isPrimitive(object: any): boolean;
- export function isString(object: any): boolean;
- export function isSymbol(object: any): boolean;
- export function isUndefined(object: any): boolean;
- export function deprecate(fn: Function, message: string): Function;
-}
-
-declare module "assert" {
- function internal(value: any, message?: string): void;
- namespace internal {
- export class AssertionError implements Error {
- name: string;
- message: string;
- actual: any;
- expected: any;
- operator: string;
- generatedMessage: boolean;
-
- constructor(options?: {
- message?: string; actual?: any; expected?: any;
- operator?: string; stackStartFunction?: Function
- });
- }
-
- export function fail(actual: any, expected: any, message: string, operator: string): void;
- export function ok(value: any, message?: string): void;
- export function equal(actual: any, expected: any, message?: string): void;
- export function notEqual(actual: any, expected: any, message?: string): void;
- export function deepEqual(actual: any, expected: any, message?: string): void;
- export function notDeepEqual(acutal: any, expected: any, message?: string): void;
- export function strictEqual(actual: any, expected: any, message?: string): void;
- export function notStrictEqual(actual: any, expected: any, message?: string): void;
- export function deepStrictEqual(actual: any, expected: any, message?: string): void;
- export function notDeepStrictEqual(actual: any, expected: any, message?: string): void;
- export var throws: {
- (block: Function, message?: string): void;
- (block: Function, error: Function, message?: string): void;
- (block: Function, error: RegExp, message?: string): void;
- (block: Function, error: (err: any) => boolean, message?: string): void;
- };
-
- export var doesNotThrow: {
- (block: Function, message?: string): void;
- (block: Function, error: Function, message?: string): void;
- (block: Function, error: RegExp, message?: string): void;
- (block: Function, error: (err: any) => boolean, message?: string): void;
- };
-
- export function ifError(value: any): void;
- }
-
- export = internal;
-}
-
-declare module "tty" {
- import * as net from "net";
-
- export function isatty(fd: number): boolean;
- export interface ReadStream extends net.Socket {
- isRaw: boolean;
- setRawMode(mode: boolean): void;
- isTTY: boolean;
- }
- export interface WriteStream extends net.Socket {
- columns: number;
- rows: number;
- isTTY: boolean;
- }
-}
-
-declare module "domain" {
- import * as events from "events";
-
- export class Domain extends events.EventEmitter implements NodeJS.Domain {
- run(fn: Function): void;
- add(emitter: events.EventEmitter): void;
- remove(emitter: events.EventEmitter): void;
- bind(cb: (err: Error, data: any) => any): any;
- intercept(cb: (data: any) => any): any;
- dispose(): void;
- members: any[];
- enter(): void;
- exit(): void;
- }
-
- export function create(): Domain;
-}
-
-declare module "constants" {
- export var E2BIG: number;
- export var EACCES: number;
- export var EADDRINUSE: number;
- export var EADDRNOTAVAIL: number;
- export var EAFNOSUPPORT: number;
- export var EAGAIN: number;
- export var EALREADY: number;
- export var EBADF: number;
- export var EBADMSG: number;
- export var EBUSY: number;
- export var ECANCELED: number;
- export var ECHILD: number;
- export var ECONNABORTED: number;
- export var ECONNREFUSED: number;
- export var ECONNRESET: number;
- export var EDEADLK: number;
- export var EDESTADDRREQ: number;
- export var EDOM: number;
- export var EEXIST: number;
- export var EFAULT: number;
- export var EFBIG: number;
- export var EHOSTUNREACH: number;
- export var EIDRM: number;
- export var EILSEQ: number;
- export var EINPROGRESS: number;
- export var EINTR: number;
- export var EINVAL: number;
- export var EIO: number;
- export var EISCONN: number;
- export var EISDIR: number;
- export var ELOOP: number;
- export var EMFILE: number;
- export var EMLINK: number;
- export var EMSGSIZE: number;
- export var ENAMETOOLONG: number;
- export var ENETDOWN: number;
- export var ENETRESET: number;
- export var ENETUNREACH: number;
- export var ENFILE: number;
- export var ENOBUFS: number;
- export var ENODATA: number;
- export var ENODEV: number;
- export var ENOENT: number;
- export var ENOEXEC: number;
- export var ENOLCK: number;
- export var ENOLINK: number;
- export var ENOMEM: number;
- export var ENOMSG: number;
- export var ENOPROTOOPT: number;
- export var ENOSPC: number;
- export var ENOSR: number;
- export var ENOSTR: number;
- export var ENOSYS: number;
- export var ENOTCONN: number;
- export var ENOTDIR: number;
- export var ENOTEMPTY: number;
- export var ENOTSOCK: number;
- export var ENOTSUP: number;
- export var ENOTTY: number;
- export var ENXIO: number;
- export var EOPNOTSUPP: number;
- export var EOVERFLOW: number;
- export var EPERM: number;
- export var EPIPE: number;
- export var EPROTO: number;
- export var EPROTONOSUPPORT: number;
- export var EPROTOTYPE: number;
- export var ERANGE: number;
- export var EROFS: number;
- export var ESPIPE: number;
- export var ESRCH: number;
- export var ETIME: number;
- export var ETIMEDOUT: number;
- export var ETXTBSY: number;
- export var EWOULDBLOCK: number;
- export var EXDEV: number;
- export var WSAEINTR: number;
- export var WSAEBADF: number;
- export var WSAEACCES: number;
- export var WSAEFAULT: number;
- export var WSAEINVAL: number;
- export var WSAEMFILE: number;
- export var WSAEWOULDBLOCK: number;
- export var WSAEINPROGRESS: number;
- export var WSAEALREADY: number;
- export var WSAENOTSOCK: number;
- export var WSAEDESTADDRREQ: number;
- export var WSAEMSGSIZE: number;
- export var WSAEPROTOTYPE: number;
- export var WSAENOPROTOOPT: number;
- export var WSAEPROTONOSUPPORT: number;
- export var WSAESOCKTNOSUPPORT: number;
- export var WSAEOPNOTSUPP: number;
- export var WSAEPFNOSUPPORT: number;
- export var WSAEAFNOSUPPORT: number;
- export var WSAEADDRINUSE: number;
- export var WSAEADDRNOTAVAIL: number;
- export var WSAENETDOWN: number;
- export var WSAENETUNREACH: number;
- export var WSAENETRESET: number;
- export var WSAECONNABORTED: number;
- export var WSAECONNRESET: number;
- export var WSAENOBUFS: number;
- export var WSAEISCONN: number;
- export var WSAENOTCONN: number;
- export var WSAESHUTDOWN: number;
- export var WSAETOOMANYREFS: number;
- export var WSAETIMEDOUT: number;
- export var WSAECONNREFUSED: number;
- export var WSAELOOP: number;
- export var WSAENAMETOOLONG: number;
- export var WSAEHOSTDOWN: number;
- export var WSAEHOSTUNREACH: number;
- export var WSAENOTEMPTY: number;
- export var WSAEPROCLIM: number;
- export var WSAEUSERS: number;
- export var WSAEDQUOT: number;
- export var WSAESTALE: number;
- export var WSAEREMOTE: number;
- export var WSASYSNOTREADY: number;
- export var WSAVERNOTSUPPORTED: number;
- export var WSANOTINITIALISED: number;
- export var WSAEDISCON: number;
- export var WSAENOMORE: number;
- export var WSAECANCELLED: number;
- export var WSAEINVALIDPROCTABLE: number;
- export var WSAEINVALIDPROVIDER: number;
- export var WSAEPROVIDERFAILEDINIT: number;
- export var WSASYSCALLFAILURE: number;
- export var WSASERVICE_NOT_FOUND: number;
- export var WSATYPE_NOT_FOUND: number;
- export var WSA_E_NO_MORE: number;
- export var WSA_E_CANCELLED: number;
- export var WSAEREFUSED: number;
- export var SIGHUP: number;
- export var SIGINT: number;
- export var SIGILL: number;
- export var SIGABRT: number;
- export var SIGFPE: number;
- export var SIGKILL: number;
- export var SIGSEGV: number;
- export var SIGTERM: number;
- export var SIGBREAK: number;
- export var SIGWINCH: number;
- export var SSL_OP_ALL: number;
- export var SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number;
- export var SSL_OP_CIPHER_SERVER_PREFERENCE: number;
- export var SSL_OP_CISCO_ANYCONNECT: number;
- export var SSL_OP_COOKIE_EXCHANGE: number;
- export var SSL_OP_CRYPTOPRO_TLSEXT_BUG: number;
- export var SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number;
- export var SSL_OP_EPHEMERAL_RSA: number;
- export var SSL_OP_LEGACY_SERVER_CONNECT: number;
- export var SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number;
- export var SSL_OP_MICROSOFT_SESS_ID_BUG: number;
- export var SSL_OP_MSIE_SSLV2_RSA_PADDING: number;
- export var SSL_OP_NETSCAPE_CA_DN_BUG: number;
- export var SSL_OP_NETSCAPE_CHALLENGE_BUG: number;
- export var SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number;
- export var SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number;
- export var SSL_OP_NO_COMPRESSION: number;
- export var SSL_OP_NO_QUERY_MTU: number;
- export var SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number;
- export var SSL_OP_NO_SSLv2: number;
- export var SSL_OP_NO_SSLv3: number;
- export var SSL_OP_NO_TICKET: number;
- export var SSL_OP_NO_TLSv1: number;
- export var SSL_OP_NO_TLSv1_1: number;
- export var SSL_OP_NO_TLSv1_2: number;
- export var SSL_OP_PKCS1_CHECK_1: number;
- export var SSL_OP_PKCS1_CHECK_2: number;
- export var SSL_OP_SINGLE_DH_USE: number;
- export var SSL_OP_SINGLE_ECDH_USE: number;
- export var SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number;
- export var SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number;
- export var SSL_OP_TLS_BLOCK_PADDING_BUG: number;
- export var SSL_OP_TLS_D5_BUG: number;
- export var SSL_OP_TLS_ROLLBACK_BUG: number;
- export var ENGINE_METHOD_DSA: number;
- export var ENGINE_METHOD_DH: number;
- export var ENGINE_METHOD_RAND: number;
- export var ENGINE_METHOD_ECDH: number;
- export var ENGINE_METHOD_ECDSA: number;
- export var ENGINE_METHOD_CIPHERS: number;
- export var ENGINE_METHOD_DIGESTS: number;
- export var ENGINE_METHOD_STORE: number;
- export var ENGINE_METHOD_PKEY_METHS: number;
- export var ENGINE_METHOD_PKEY_ASN1_METHS: number;
- export var ENGINE_METHOD_ALL: number;
- export var ENGINE_METHOD_NONE: number;
- export var DH_CHECK_P_NOT_SAFE_PRIME: number;
- export var DH_CHECK_P_NOT_PRIME: number;
- export var DH_UNABLE_TO_CHECK_GENERATOR: number;
- export var DH_NOT_SUITABLE_GENERATOR: number;
- export var NPN_ENABLED: number;
- export var RSA_PKCS1_PADDING: number;
- export var RSA_SSLV23_PADDING: number;
- export var RSA_NO_PADDING: number;
- export var RSA_PKCS1_OAEP_PADDING: number;
- export var RSA_X931_PADDING: number;
- export var RSA_PKCS1_PSS_PADDING: number;
- export var POINT_CONVERSION_COMPRESSED: number;
- export var POINT_CONVERSION_UNCOMPRESSED: number;
- export var POINT_CONVERSION_HYBRID: number;
- export var O_RDONLY: number;
- export var O_WRONLY: number;
- export var O_RDWR: number;
- export var S_IFMT: number;
- export var S_IFREG: number;
- export var S_IFDIR: number;
- export var S_IFCHR: number;
- export var S_IFBLK: number;
- export var S_IFIFO: number;
- export var S_IFSOCK: number;
- export var S_IRWXU: number;
- export var S_IRUSR: number;
- export var S_IWUSR: number;
- export var S_IXUSR: number;
- export var S_IRWXG: number;
- export var S_IRGRP: number;
- export var S_IWGRP: number;
- export var S_IXGRP: number;
- export var S_IRWXO: number;
- export var S_IROTH: number;
- export var S_IWOTH: number;
- export var S_IXOTH: number;
- export var S_IFLNK: number;
- export var O_CREAT: number;
- export var O_EXCL: number;
- export var O_NOCTTY: number;
- export var O_DIRECTORY: number;
- export var O_NOATIME: number;
- export var O_NOFOLLOW: number;
- export var O_SYNC: number;
- export var O_SYMLINK: number;
- export var O_DIRECT: number;
- export var O_NONBLOCK: number;
- export var O_TRUNC: number;
- export var O_APPEND: number;
- export var F_OK: number;
- export var R_OK: number;
- export var W_OK: number;
- export var X_OK: number;
- export var UV_UDP_REUSEADDR: number;
- export var SIGQUIT: number;
- export var SIGTRAP: number;
- export var SIGIOT: number;
- export var SIGBUS: number;
- export var SIGUSR1: number;
- export var SIGUSR2: number;
- export var SIGPIPE: number;
- export var SIGALRM: number;
- export var SIGCHLD: number;
- export var SIGSTKFLT: number;
- export var SIGCONT: number;
- export var SIGSTOP: number;
- export var SIGTSTP: number;
- export var SIGTTIN: number;
- export var SIGTTOU: number;
- export var SIGURG: number;
- export var SIGXCPU: number;
- export var SIGXFSZ: number;
- export var SIGVTALRM: number;
- export var SIGPROF: number;
- export var SIGIO: number;
- export var SIGPOLL: number;
- export var SIGPWR: number;
- export var SIGSYS: number;
- export var SIGUNUSED: number;
- export var defaultCoreCipherList: string;
- export var defaultCipherList: string;
- export var ENGINE_METHOD_RSA: number;
- export var ALPN_ENABLED: number;
-}
-
-declare module "process" {
- export = process;
-}
-
-declare module "v8" {
- interface HeapSpaceInfo {
- space_name: string;
- space_size: number;
- space_used_size: number;
- space_available_size: number;
- physical_space_size: number;
- }
- export function getHeapStatistics(): { total_heap_size: number, total_heap_size_executable: number, total_physical_size: number, total_avaialble_size: number, used_heap_size: number, heap_size_limit: number };
- export function getHeapSpaceStatistics(): HeapSpaceInfo[];
- export function setFlagsFromString(flags: string): void;
-}
-
-declare module "timers" {
- export function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer;
- export function clearTimeout(timeoutId: NodeJS.Timer): void;
- export function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer;
- export function clearInterval(intervalId: NodeJS.Timer): void;
- export function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any;
- export function clearImmediate(immediateId: any): void;
-}
-
-declare module "console" {
- export = console;
-}
diff --git a/src/lookup/ExtractCTABComponent.ts b/src/lookup/ExtractCTABComponent.ts
index 85e9b18..eee0afb 100644
--- a/src/lookup/ExtractCTABComponent.ts
+++ b/src/lookup/ExtractCTABComponent.ts
@@ -10,7 +10,13 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {MDLMOLReader, MDLReaderGroupMixture, MDLReaderLinkNode} from '../../wmk/data/MDLReader';
+import {MDLMOLWriter} from '../../wmk/data/MDLWriter';
+import {Molecule} from '../../wmk/data/Molecule';
+import {MolUtil} from '../../wmk/data/MolUtil';
+import {deepClone} from '../../wmk/util/util';
+import {Vec} from '../../wmk/util/Vec';
+import {MixfileComponent} from '../data/Mixfile';
/*
Checks the supplied string to see if it is a CTAB (V2000/V3000) with features that make enumerable. If so,
@@ -19,13 +25,13 @@ namespace Mixtures /* BOF */ {
interface ProtoMolecule
{
- mol:wmk.Molecule;
+ mol:Molecule;
children:ProtoMolecule[];
attachAny:Map<number, number[]>; // bond -> list of atom indices
stereoRacemic:number[][]; // blocks of atoms which are racemic
stereoRelative:number[][]; // blocks of atoms which exist in their drawn configuration OR the opposite
- linkNodes:wmk.MDLReaderLinkNode[]; // so-called link nodes, aka repeating atom
- mixtures:wmk.MDLReaderGroupMixture[]; // mixture collections, which may overlap
+ linkNodes:MDLReaderLinkNode[]; // so-called link nodes, aka repeating atom
+ mixtures:MDLReaderGroupMixture[]; // mixture collections, which may overlap
}
export class ExtractCTABComponent
@@ -41,7 +47,7 @@ export class ExtractCTABComponent
// or is just a plain ordinary single molecule, returns null
public extract():MixfileComponent
{
- let ctab = new wmk.MDLMOLReader(this.text);
+ let ctab = new MDLMOLReader(this.text);
try {ctab.parse();}
catch (ex) {return null;}
@@ -85,7 +91,7 @@ export class ExtractCTABComponent
let emit = (comp:MixfileComponent, proto:ProtoMolecule):void =>
{
let subComp:MixfileComponent = {};
- if (proto.mol) subComp.molfile = new wmk.MDLMOLWriter(proto.mol).write();
+ if (proto.mol) subComp.molfile = new MDLMOLWriter(proto.mol).write();
comp.contents.push(subComp);
if (proto.children)
{
@@ -159,7 +165,7 @@ export class ExtractCTABComponent
for (let n = 1; n <= mol.numBonds; n++) if (affected.has(mol.bondFrom(n)) || affected.has(mol.bondTo(n)))
{
let bt = mol.bondType(n);
- if (bt == wmk.Molecule.BONDTYPE_INCLINED || bt == wmk.Molecule.BONDTYPE_DECLINED) bonds.push(n);
+ if (bt == Molecule.BONDTYPE_INCLINED || bt == Molecule.BONDTYPE_DECLINED) bonds.push(n);
}
let nperm = Math.min(256, 1 << bonds.length);
@@ -172,7 +178,7 @@ export class ExtractCTABComponent
if (n & bitand)
{
let bt = rmol.bondType(bonds[i]);
- bt = bt == wmk.Molecule.BONDTYPE_INCLINED ? wmk.Molecule.BONDTYPE_DECLINED : wmk.Molecule.BONDTYPE_INCLINED;
+ bt = bt == Molecule.BONDTYPE_INCLINED ? Molecule.BONDTYPE_DECLINED : Molecule.BONDTYPE_INCLINED;
rmol.setBondType(bonds[i], bt);
}
bitand = bitand << 1;
@@ -196,8 +202,8 @@ export class ExtractCTABComponent
for (let n = 1; n <= molinv.numBonds; n++) if (affected.has(molinv.bondFrom(n)) || affected.has(molinv.bondTo(n)))
{
let bt = molinv.bondType(n);
- if (bt == wmk.Molecule.BONDTYPE_INCLINED) molinv.setBondType(n, wmk.Molecule.BONDTYPE_DECLINED);
- else if (bt == wmk.Molecule.BONDTYPE_DECLINED) molinv.setBondType(n, wmk.Molecule.BONDTYPE_INCLINED);
+ if (bt == Molecule.BONDTYPE_INCLINED) molinv.setBondType(n, Molecule.BONDTYPE_DECLINED);
+ else if (bt == Molecule.BONDTYPE_DECLINED) molinv.setBondType(n, Molecule.BONDTYPE_INCLINED);
}
return [proto, this.protoClone(proto, molinv)];
@@ -295,7 +301,7 @@ export class ExtractCTABComponent
let atommask = nonemask.slice(0);
for (let a of mixtures[n].atoms) atommask[a - 1] = true;
- let mixmol = wmk.MolUtil.subgraphMask(mol, atommask);
+ let mixmol = MolUtil.subgraphMask(mol, atommask);
let node = {'mol': mixmol} as ProtoMolecule;
mapTree.get(mixtures[n].parent).children.push(node);
}
@@ -305,7 +311,7 @@ export class ExtractCTABComponent
}
// makes a copy of the prototype's fields, and copies over the replacement molecule
- private protoClone(proto:ProtoMolecule, mol:wmk.Molecule):ProtoMolecule
+ private protoClone(proto:ProtoMolecule, mol:Molecule):ProtoMolecule
{
let dup:ProtoMolecule =
{
@@ -330,5 +336,3 @@ export class ExtractCTABComponent
}
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/lookup/LookupCompoundDialog.ts b/src/lookup/LookupCompoundDialog.ts
index d5c4e1e..e853fbf 100644
--- a/src/lookup/LookupCompoundDialog.ts
+++ b/src/lookup/LookupCompoundDialog.ts
@@ -10,13 +10,22 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {Molecule} from '../../wmk/data/Molecule';
+import {Dialog} from '../../wmk/dialog/Dialog';
+import {OutlineMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {ArrangeMolecule} from '../../wmk/gfx/ArrangeMolecule';
+import {DrawMolecule} from '../../wmk/gfx/DrawMolecule';
+import {MetaVector} from '../../wmk/gfx/MetaVector';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {dom, DOM} from '../../wmk/util/dom';
+import {hasInlineCSS, installInlineCSS} from '../../wmk/util/Theme';
+import {PubChemSearch, PubChemSearchResult} from './PubChemSearch';
/*
Dialog for finding a compound by name using remote webservices.
*/
-export class LookupCompoundDialog extends wmk.Dialog
+export class LookupCompoundDialog extends Dialog
{
private spanStatus:DOM;
private btnSearch:DOM;
@@ -32,7 +41,7 @@ export class LookupCompoundDialog extends wmk.Dialog
private nameList:string[] = [];
private nameDOM:DOM[] = [];
private molSelected = -1;
- private molList:wmk.Molecule[] = [];
+ private molList:Molecule[] = [];
private molDOM:DOM[] = [];
private callbackSelect:(source?:LookupCompoundDialog) => void = null;
@@ -43,7 +52,7 @@ export class LookupCompoundDialog extends wmk.Dialog
{
super();
- if (!wmk.hasInlineCSS('mixtures-lookupcompound')) wmk.installInlineCSS('mixtures-lookupcompound', this.composeCSS());
+ if (!hasInlineCSS('mixtures-lookupcompound')) installInlineCSS('mixtures-lookupcompound', this.composeCSS());
this.title = 'Lookup Compound';
this.minPortionWidth = 95;
@@ -105,7 +114,7 @@ export class LookupCompoundDialog extends wmk.Dialog
{
return this.nameSelected < 0 ? null : this.nameList[this.nameSelected];
}
- public getMolecule():wmk.Molecule
+ public getMolecule():Molecule
{
return this.molSelected < 0 ? null : this.molList[this.molSelected];
}
@@ -165,13 +174,13 @@ export class LookupCompoundDialog extends wmk.Dialog
if (result.mol)
{
- let policy = wmk.RenderPolicy.defaultColourOnWhite();
- let measure = new wmk.OutlineMeasurement(0, 0, policy.data.pointScale);
- let layout = new wmk.ArrangeMolecule(result.mol, measure, policy);
+ let policy = RenderPolicy.defaultColourOnWhite();
+ let measure = new OutlineMeasurement(0, 0, policy.data.pointScale);
+ let layout = new ArrangeMolecule(result.mol, measure, policy);
layout.arrange();
layout.squeezeInto(0, 0, 300, 300);
- let gfx = new wmk.MetaVector();
- new wmk.DrawMolecule(layout, gfx).draw();
+ let gfx = new MetaVector();
+ new DrawMolecule(layout, gfx).draw();
gfx.normalise();
let svg = dom(gfx.createSVG()).appendTo(divMol).css({'display': 'inline-block'});
@@ -274,5 +283,3 @@ export class LookupCompoundDialog extends wmk.Dialog
`;
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/lookup/PubChemSearch.ts b/src/lookup/PubChemSearch.ts
index 8abd33a..6da1479 100644
--- a/src/lookup/PubChemSearch.ts
+++ b/src/lookup/PubChemSearch.ts
@@ -10,7 +10,11 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {CoordUtil} from '../../wmk/data/CoordUtil';
+import {DataSheet} from '../../wmk/data/DataSheet';
+import {MDLSDFReader} from '../../wmk/data/MDLReader';
+import {Molecule} from '../../wmk/data/Molecule';
+import {MolUtil} from '../../wmk/data/MolUtil';
/*
Searching PubChem via the REST API, using names to track down other information, primarily structure.
@@ -21,7 +25,7 @@ const BASE_COMPOUND = 'https://pubchem.ncbi.nlm.nih.gov/rest/pug/compound';
export interface PubChemSearchResult
{
- mol:wmk.Molecule;
+ mol:Molecule;
names:string[];
formula:string;
inchi:string;
@@ -130,13 +134,13 @@ export class PubChemSearch
{
if (this.stopped) return;
- let ds = new wmk.MDLSDFReader(data).parse();
+ let ds = new MDLSDFReader(data).parse();
for (let n = 0; n < ds.numRows; n++) this.unpackCompound(ds, n);
this.fetchNext();
}
- private unpackCompound(ds:wmk.DataSheet, row:number):void
+ private unpackCompound(ds:DataSheet, row:number):void
{
let result:PubChemSearchResult =
{
@@ -149,8 +153,8 @@ export class PubChemSearch
if (result.mol)
{
- wmk.MolUtil.stripHydrogens(result.mol);
- wmk.CoordUtil.normaliseBondDistances(result.mol);
+ MolUtil.stripHydrogens(result.mol);
+ CoordUtil.normaliseBondDistances(result.mol);
}
const NAMECOLS = ['PUBCHEM_IUPAC_TRADITIONAL_NAME', 'PUBCHEM_IUPAC_SYSTEMATIC_NAME',
@@ -165,5 +169,3 @@ export class PubChemSearch
this.callbackResult(result);
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/main/CollectionPanel.ts b/src/main/CollectionPanel.ts
index e10c92a..8ece4fe 100644
--- a/src/main/CollectionPanel.ts
+++ b/src/main/CollectionPanel.ts
@@ -10,10 +10,22 @@
Made available under the Gnu Public License v3.0
*/
-///<reference path='MenuBanner.ts'/>
-///<reference path='MainPanel.ts'/>
-
-namespace Mixtures /* BOF */ {
+import {OutlineMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {FontData} from '../../wmk/gfx/FontData';
+import {MetaVector, TextAlign} from '../../wmk/gfx/MetaVector';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {ClipboardProxy} from '../../wmk/ui/ClipboardProxy';
+import {MenuProxy} from '../../wmk/ui/MenuProxy';
+import {dom, DOM} from '../../wmk/util/dom';
+import {Vec} from '../../wmk/util/Vec';
+import {Mixture} from '../data/Mixture';
+import {MixtureCollection} from '../data/MixtureCollection';
+import {ArrangeMixture} from '../mixture/ArrangeMixture';
+import {DrawMixture} from '../mixture/DrawMixture';
+import {EditMixture} from '../mixture/EditMixture';
+import {openNewWindow} from '../startup';
+import {MainPanel} from './MainPanel';
+import {MenuBanner, MenuBannerButton, MenuBannerCommand} from './MenuBanner';
/*
Browsing/editing a collection of mixtures.
@@ -76,7 +88,7 @@ export class CollectionPanel extends MainPanel
private banner:MenuBanner;
private divMain:DOM;
private divFooter:DOM;
- private policy = wmk.RenderPolicy.defaultColourOnWhite(20);
+ private policy = RenderPolicy.defaultColourOnWhite(20);
private viewType = CollectionPanelView.Detail;
private selected = -1;
@@ -85,7 +97,7 @@ export class CollectionPanel extends MainPanel
// ------------ public methods ------------
- constructor(root:DOM, private proxyClip:wmk.ClipboardProxy, private proxyMenu:wmk.MenuProxy)
+ constructor(root:DOM, private proxyClip:ClipboardProxy, private proxyMenu:MenuProxy)
{
super(root);
@@ -348,18 +360,18 @@ export class CollectionPanel extends MainPanel
divInner.css({'margin': '2px', 'padding': '2px', 'border-radius': '4px'});
divInner.css({'background-color': BG_NORMAL, 'border': '1px solid #808080'});
- let measure = new wmk.OutlineMeasurement(0, 0, this.policy.data.pointScale);
+ let measure = new OutlineMeasurement(0, 0, this.policy.data.pointScale);
let layout = new ArrangeMixture(mixture, measure, this.policy);
layout.arrange();
- let gfx = new wmk.MetaVector();
+ let gfx = new MetaVector();
let draw = new DrawMixture(layout, gfx);
draw.draw();
let tag = (idx + 1).toString(), fsz = 10, tpad = 2;
- let wad = wmk.FontData.measureText(tag, fsz);
- gfx.drawRect(0, 0, wad[0] + 2 * tpad, wad[1] + 2 * tpad, wmk.MetaVector.NOCOLOUR, 0, 0x000000);
- gfx.drawText(0 + tpad, tpad, tag, fsz, 0xFFFFFF, wmk.TextAlign.Top | wmk.TextAlign.Left);
+ let wad = FontData.measureText(tag, fsz);
+ gfx.drawRect(0, 0, wad[0] + 2 * tpad, wad[1] + 2 * tpad, MetaVector.NOCOLOUR, 0, 0x000000);
+ gfx.drawText(0 + tpad, tpad, tag, fsz, 0xFFFFFF, TextAlign.Top | TextAlign.Left);
gfx.normalise();
let wrapSVG = dom('<div/>').appendTo(divInner).css({'display': 'inline-block'});
@@ -675,5 +687,3 @@ export class CollectionPanel extends MainPanel
}
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/main/InChI.ts b/src/main/InChI.ts
index 196ebb8..7de8eb6 100644
--- a/src/main/InChI.ts
+++ b/src/main/InChI.ts
@@ -10,7 +10,10 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {MDLMOLWriter} from '../../wmk/data/MDLWriter';
+import {Molecule} from '../../wmk/data/Molecule';
+import {MolUtil} from '../../wmk/data/MolUtil';
+import {ON_DESKTOP} from '../startup';
/*
Interoperability with InChI technology: the generator program is a native binary, the location of which
@@ -73,13 +76,13 @@ export class InChI
// converts a molecule to an InChI string, if possible; should check the availability first, for graceful
// rejection; failure results in an exception; note that it is executed synchronously: if the executable takes
// a long time to run, this will be a problem for the UI; the return value is [InChI, InChIKey]
- public static async makeInChI(mol:wmk.Molecule):Promise<[string, string]>
+ public static async makeInChI(mol:Molecule):Promise<[string, string]>
{
mol = mol.clone();
- wmk.MolUtil.expandAbbrevs(mol, true);
+ MolUtil.expandAbbrevs(mol, true);
for (let n = 1; n <= mol.numBonds; n++) if (mol.bondOrder(n) < 1 || mol.bondOrder(n) > 3) mol.setBondOrder(n, 1);
- let writer = new wmk.MDLMOLWriter(mol);
+ let writer = new MDLMOLWriter(mol);
writer.enhancedFields = false;
let mdlmol = writer.write();
@@ -108,5 +111,3 @@ export class InChI
return bits;
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/main/MainPanel.ts b/src/main/MainPanel.ts
index 1e684f6..2b95518 100644
--- a/src/main/MainPanel.ts
+++ b/src/main/MainPanel.ts
@@ -10,7 +10,9 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {dom, DOM} from '../../wmk/util/dom';
+import {openNewWindow} from '../startup';
+import {MenuBannerCommand} from './MenuBanner';
/*
Base class for "main windows": an object that takes up the entire browser window document, responds to resizing, etc.
@@ -68,4 +70,3 @@ export abstract class MainPanel
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/main/MenuBanner.ts b/src/main/MenuBanner.ts
index df39d87..1b0b79d 100644
--- a/src/main/MenuBanner.ts
+++ b/src/main/MenuBanner.ts
@@ -10,7 +10,11 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {addTooltip} from '../../wmk/ui/Tooltip';
+import {dom, DOM} from '../../wmk/util/dom';
+import {Box} from '../../wmk/util/Geom';
+import {installInlineCSS, Theme} from '../../wmk/util/Theme';
+import {escapeHTML} from '../../wmk/util/util';
/*
A banner that goes along the top of the screen and fills up with clickable icons.
@@ -83,7 +87,7 @@ export class MenuBanner
constructor(private commands:MenuBannerButton[][], private callbackAction:(cmd:string) => void)
{
- wmk.installInlineCSS('mixtures-menubanner', CSS_MENUBANNER);
+ installInlineCSS('mixtures-menubanner', CSS_MENUBANNER);
}
public render(domParent:DOM):void
@@ -136,11 +140,11 @@ export class MenuBanner
}
// fetch the position of the given icon, relative to the banner overall
- public iconPosition(cmd:MenuBannerCommand):wmk.Box
+ public iconPosition(cmd:MenuBannerCommand):Box
{
let div = this.mapDiv[cmd];
if (!div) return null;
- return new wmk.Box(div.elHTML.offsetLeft, div.elHTML.offsetTop, div.width(), div.height());
+ return new Box(div.elHTML.offsetLeft, div.elHTML.offsetTop, div.width(), div.height());
}
// ------------ private methods ------------
@@ -154,7 +158,7 @@ export class MenuBanner
div.css({'border-radius': '4px'});
if (this.selected.has(btn.cmd)) div.css({'background-color': '#D0D0D0'});
- let imgURL = wmk.Theme.RESOURCE_URL + '/img/icons/' + btn.icon;
+ let imgURL = Theme.RESOURCE_URL + '/img/icons/' + btn.icon;
let svg = dom('<img/>').appendTo(div).attr({'src': imgURL});
div.addClass('mixtures-menubanner-button');
@@ -175,10 +179,8 @@ export class MenuBanner
if (!this.mapActive[btn.cmd]) return;
this.callbackAction(btn.cmd);
});
- if (btn.tip) wmk.addTooltip(div, escapeHTML(btn.tip));
+ if (btn.tip) addTooltip(div, escapeHTML(btn.tip));
return [div, svg];
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/main/MixturePanel.ts b/src/main/MixturePanel.ts
index 28d7ce9..fc52694 100644
--- a/src/main/MixturePanel.ts
+++ b/src/main/MixturePanel.ts
@@ -10,10 +10,26 @@
Made available under the Gnu Public License v3.0
*/
-///<reference path='MenuBanner.ts'/>
-///<reference path='MainPanel.ts'/>
-
-namespace Mixtures /* BOF */ {
+import {Dialog} from '../../wmk/dialog/Dialog';
+import {OutlineMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {MetaVector} from '../../wmk/gfx/MetaVector';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {ClipboardProxy, ClipboardProxyHandler} from '../../wmk/ui/ClipboardProxy';
+import {MenuProxy} from '../../wmk/ui/MenuProxy';
+import {dom, DOM} from '../../wmk/util/dom';
+import {Size} from '../../wmk/util/Geom';
+import {yieldDOM} from '../../wmk/util/util';
+import {MIXFILE_VERSION} from '../data/Mixfile';
+import {Mixture} from '../data/Mixture';
+import {ArrangeMixture} from '../mixture/ArrangeMixture';
+import {DrawMixture} from '../mixture/DrawMixture';
+import {EditMixture} from '../mixture/EditMixture';
+import {ExportMInChI, MInChISegment} from '../mixture/ExportMInChI';
+import {ExportSDFile} from '../mixture/ExportSDFile';
+import {openNewWindow} from '../startup';
+import {InChI} from './InChI';
+import {MainPanel} from './MainPanel';
+import {MenuBanner, MenuBannerButton, MenuBannerCommand} from './MenuBanner';
/*
Viewing/editing window: dedicated entirely to the sketching of a mixture.
@@ -63,7 +79,7 @@ export class MixturePanel extends MainPanel
// ------------ public methods ------------
- constructor(root:DOM, private proxyClip:wmk.ClipboardProxy, private proxyMenu:wmk.MenuProxy)
+ constructor(root:DOM, private proxyClip:ClipboardProxy, private proxyMenu:MenuProxy)
{
super(root);
@@ -341,15 +357,15 @@ export class MixturePanel extends MainPanel
dialog.showSaveDialog(params).then((value) =>
{
if (value.canceled) return;
- let policy = wmk.RenderPolicy.defaultColourOnWhite();
- let measure = new wmk.OutlineMeasurement(0, 0, policy.data.pointScale);
+ let policy = RenderPolicy.defaultColourOnWhite();
+ let measure = new OutlineMeasurement(0, 0, policy.data.pointScale);
let layout = new ArrangeMixture(this.editor.getMixture(), measure, policy);
layout.collapsedBranches = this.editor.getCollapsedBranches();
// TODO: decide whether to pack the branches...
- layout.packBranches = new wmk.Size(0.8 * this.editor.contentDOM.width(), 0.8 * this.editor.contentDOM.height());
+ layout.packBranches = new Size(0.8 * this.editor.contentDOM.width(), 0.8 * this.editor.contentDOM.height());
layout.arrange();
- let gfx = new wmk.MetaVector();
+ let gfx = new MetaVector();
new DrawMixture(layout, gfx).draw();
gfx.normalise();
let svg = gfx.createSVG(true, true);
@@ -372,7 +388,7 @@ export class MixturePanel extends MainPanel
let maker = new ExportMInChI(this.editor.getMixture().mixfile);
let self = this;
- class MInChIDialog extends wmk.Dialog
+ class MInChIDialog extends Dialog
{
constructor()
{
@@ -381,7 +397,7 @@ export class MixturePanel extends MainPanel
}
protected populate():void
{
- self.proxyClip.pushHandler(new wmk.ClipboardProxyHandler());
+ self.proxyClip.pushHandler(new ClipboardProxyHandler());
this.bodyDOM().setText('Calculating...');
(async () => await this.renderResult())();
}
@@ -392,19 +408,19 @@ export class MixturePanel extends MainPanel
}
private async renderResult():Promise<void>
{
- await wmk.yieldDOM();
+ await yieldDOM();
await maker.fillInChI();
maker.formulate();
let body = this.bodyDOM();
body.empty();
- let divOuter = wmk.dom('<div/>').appendTo(body);
- let pre = wmk.dom('<span/>').appendTo(divOuter).css({'font-family': 'monospace', 'padding-top': '0.5em', 'word-break': 'break-all'});
+ let divOuter = dom('<div/>').appendTo(body);
+ let pre = dom('<span/>').appendTo(divOuter).css({'font-family': 'monospace', 'padding-top': '0.5em', 'word-break': 'break-all'});
let minchi = maker.getResult(), segment = maker.getSegment();
for (let n = 0; n < minchi.length; n++)
{
- let span = wmk.dom('<span/>').appendTo(pre);
+ let span = dom('<span/>').appendTo(pre);
span.setText(minchi[n]);
if (segment[n] == MInChISegment.Header) span.setCSS('background-color', '#FFC0C0');
else if (segment[n] == MInChISegment.Component) span.setCSS('background-color', '#C0C0FF');
@@ -413,7 +429,7 @@ export class MixturePanel extends MainPanel
pre.appendHTML('<wbr/>');
}
- let btnCopy = wmk.dom('<button class="wmk-button wmk-button-small wmk-button-default">Copy</button>').appendTo(divOuter).css({'margin-left': '0.5em'});
+ let btnCopy = dom('<button class="wmk-button wmk-button-small wmk-button-default">Copy</button>').appendTo(divOuter).css({'margin-left': '0.5em'});
btnCopy.onClick(() => self.proxyClip.setString(minchi));
}
}
@@ -430,5 +446,3 @@ export class MixturePanel extends MainPanel
document.title = title;
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/ArrangeMixture.ts b/src/mixture/ArrangeMixture.ts
index 0f1e414..d627303 100644
--- a/src/mixture/ArrangeMixture.ts
+++ b/src/mixture/ArrangeMixture.ts
@@ -10,7 +10,20 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {Molecule} from '../../wmk/data/Molecule';
+import {MoleculeStream} from '../../wmk/data/MoleculeStream';
+import {OntologyTree} from '../../wmk/data/OntologyTree';
+import {ArrangeMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {ArrangeMolecule} from '../../wmk/gfx/ArrangeMolecule';
+import {FontData} from '../../wmk/gfx/FontData';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {Box, Size} from '../../wmk/util/Geom';
+import {formatDouble} from '../../wmk/util/util';
+import {Vec} from '../../wmk/util/Vec';
+import {MixfileComponent} from '../data/Mixfile';
+import {Mixture} from '../data/Mixture';
+import {NormMixture} from '../data/NormMixture';
+import {SquarePacking} from './SquarePacking';
/*
Arranging a Mixfile: will create a tree layout for all of the components, according to parameters.
@@ -28,20 +41,20 @@ export interface ArrangeMixtureComponent
content:MixfileComponent;
parentIdx:number;
- boundary?:wmk.Box; // outer boundary (position on canvas)
+ boundary?:Box; // outer boundary (position on canvas)
- mol?:wmk.Molecule;
- molLayout?:wmk.ArrangeMolecule;
- molBox?:wmk.Box;
+ mol?:Molecule;
+ molLayout?:ArrangeMolecule;
+ molBox?:Box;
- nameBox?:wmk.Box;
+ nameBox?:Box;
nameLines?:ArrangeMixtureLine[];
fontSize?:number;
- outline?:wmk.Box; // inner boundary (surrounds molecule, names, etc.)
+ outline?:Box; // inner boundary (surrounds molecule, names, etc.)
isCollapsed?:boolean;
- collapseBox?:wmk.Box;
+ collapseBox?:Box;
}
const PADDING = 0.25;
@@ -64,17 +77,17 @@ export class ArrangeMixture
// parameters to influence the drawing
public limitStructW:number;
public limitStructH:number;
- public minBoxSize:wmk.Size = null;
+ public minBoxSize:Size = null;
public showCollapsors = false; // if true, boxes for [+]/[-] will be created for interactive use
public collapsedBranches:number[][] = []; // any origin specified in this list will not display its children
- public packBranches:wmk.Size = null; // if defined, makes an effort to pack branches into the box size
+ public packBranches:Size = null; // if defined, makes an effort to pack branches into the box size
public hardwrapName:number; // name width guaranteed not longer than this
public softwrapName:number; // name wrapping at selected characters kicks in after this width
// --------------------- public methods ---------------------
// sets up the object with the mandatory information
- constructor(public mixture:Mixture, public measure:wmk.ArrangeMeasurement, public policy:wmk.RenderPolicy)
+ constructor(public mixture:Mixture, public measure:ArrangeMeasurement, public policy:RenderPolicy)
{
this.scale = policy.data.pointScale;
this.nameFontSize = 0.5 * this.scale;
@@ -91,7 +104,7 @@ export class ArrangeMixture
this.contractComponents();
// normalize boundaries
- let outline:wmk.Box = null;
+ let outline:Box = null;
for (let comp of this.components)
{
if (outline) outline = outline.union(comp.boundary); else outline = comp.boundary;
@@ -251,16 +264,16 @@ export class ArrangeMixture
let mixcomp = comp.content;
// handle molecule, if any
- if (mixcomp.molfile) comp.mol = wmk.MoleculeStream.readUnknown(mixcomp.molfile);
+ if (mixcomp.molfile) comp.mol = MoleculeStream.readUnknown(mixcomp.molfile);
if (comp.mol)
{
- comp.molLayout = new wmk.ArrangeMolecule(comp.mol, this.measure, this.policy);
+ comp.molLayout = new ArrangeMolecule(comp.mol, this.measure, this.policy);
comp.molLayout.arrange();
comp.molLayout.squeezeInto(0, 0, this.limitStructW, this.limitStructH);
let bounds = comp.molLayout.determineBoundary();
- comp.molBox = new wmk.Box(padding, padding, Math.ceil(bounds[2] - bounds[0]), Math.ceil(bounds[3] - bounds[1]));
+ comp.molBox = new Box(padding, padding, Math.ceil(bounds[2] - bounds[0]), Math.ceil(bounds[3] - bounds[1]));
}
- else comp.molBox = wmk.Box.zero();
+ else comp.molBox = Box.zero();
// handle name, or other content needing representation
comp.nameLines = [];
@@ -288,9 +301,9 @@ export class ArrangeMixture
{
let metaString = (m:string | number):string =>
{
- if (typeof m == 'number') return wmk.formatDouble(m, 4);
- if (!wmk.OntologyTree.main) return m;
- let branch = wmk.OntologyTree.main.getBranch(m);
+ if (typeof m == 'number') return formatDouble(m, 4);
+ if (!OntologyTree.main) return m;
+ let branch = OntologyTree.main.getBranch(m);
if (Vec.notBlank(branch)) return branch[0].label;
return m;
};
@@ -299,7 +312,7 @@ export class ArrangeMixture
comp.nameLines.push({'text': bits.join(' '), 'col': 0x002B88});
}
- comp.nameBox = new wmk.Box(padding, padding);
+ comp.nameBox = new Box(padding, padding);
comp.fontSize = this.nameFontSize;
for (let n = 0; n < comp.nameLines.length; n++)
{
@@ -308,7 +321,7 @@ export class ArrangeMixture
comp.nameBox.h += wad[1] + (n > 0 ? wad[2] * 2 : 0);
}
- comp.outline = wmk.Box.zero();
+ comp.outline = Box.zero();
comp.outline.w = Math.max(comp.molBox.w, comp.nameBox.w) + 2 * padding;
comp.outline.h = comp.molBox.h + comp.nameBox.h + 2 * padding;
if (comp.molBox.notEmpty() && comp.nameBox.notEmpty())
@@ -340,7 +353,7 @@ export class ArrangeMixture
if ((this.showCollapsors || comp.isCollapsed) && Vec.notBlank(comp.content.contents))
{
let gap = COLLAPSE_GAP * this.scale, wh = COLLAPSE_SIZE * this.scale;
- comp.collapseBox = new wmk.Box(comp.boundary.maxX() + gap, comp.boundary.midY() - 0.5 * wh, wh, wh);
+ comp.collapseBox = new Box(comp.boundary.maxX() + gap, comp.boundary.midY() - 0.5 * wh, wh, wh);
comp.boundary.w += gap + wh;
}
}
@@ -352,7 +365,7 @@ export class ArrangeMixture
{
let wholeBranch:number[] = [idx];
let branchBlock:number[][] = [];
- let branchBox:wmk.Box[] = [];
+ let branchBox:Box[] = [];
let totalWidth = 0, totalHeight = 0;
@@ -364,7 +377,7 @@ export class ArrangeMixture
let branch = this.layoutSubComponents(n);
if (branch.length == 0) continue;
- let box:wmk.Box = null;
+ let box:Box = null;
for (let i of branch)
{
wholeBranch.push(i);
@@ -432,7 +445,7 @@ export class ArrangeMixture
private contractComponents():void
{
let allChildren:number[][] = [];
- for (let n = 0; n < this.components.length; n++)
+ for (let n = 0; n < this.components.length; n++)
{
allChildren.push([]);
for (let idx = this.components[n].parentIdx; idx >= 0; idx = this.components[idx].parentIdx) allChildren[idx].push(n);
@@ -483,7 +496,7 @@ export class ArrangeMixture
private wrapSplitName(list:ArrangeMixtureLine[], text:string, col:number):void
{
if (!text) return;
- let xpos = wmk.FontData.measureWidths(text, this.nameFontSize);
+ let xpos = FontData.measureWidths(text, this.nameFontSize);
if (Vec.last(xpos) <= this.softwrapName)
{
list.push({text, col});
@@ -509,13 +522,11 @@ export class ArrangeMixture
// if the line is longer than the hard wrap limit, just truncate with ellipsis
private truncateEllipsis(txt:string):string
{
- let xpos = wmk.FontData.measureWidths(txt, this.nameFontSize);
+ let xpos = FontData.measureWidths(txt, this.nameFontSize);
if (Vec.last(xpos) <= this.hardwrapName) return txt;
- let ellipsis = '...', ellw = wmk.FontData.measureText(ellipsis, this.nameFontSize)[0];
+ let ellipsis = '...', ellw = FontData.measureText(ellipsis, this.nameFontSize)[0];
let keep = 1;
for (; keep < txt.length; keep++) if (xpos[keep] + ellw > this.hardwrapName) break;
return txt.substring(0, keep) + ellipsis;
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/DrawMixture.ts b/src/mixture/DrawMixture.ts
index 6191ef9..bf6bc8f 100644
--- a/src/mixture/DrawMixture.ts
+++ b/src/mixture/DrawMixture.ts
@@ -10,7 +10,11 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {ArrangeMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {DrawMolecule} from '../../wmk/gfx/DrawMolecule';
+import {MetaVector, TextAlign} from '../../wmk/gfx/MetaVector';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {ArrangeMixture, ArrangeMixtureComponent} from './ArrangeMixture';
/*
Drawing a Mixfile, which has been rendered.
@@ -22,15 +26,15 @@ export class DrawMixture
public activeIndex = -1; // component that is actively engaged with UI
public selectedIndex = -1; // component that is passively selected
- private measure:wmk.ArrangeMeasurement;
- private policy:wmk.RenderPolicy;
+ private measure:ArrangeMeasurement;
+ private policy:RenderPolicy;
private scale:number;
private invScale:number;
// --------------------- public methods ---------------------
- constructor(private layout:ArrangeMixture, private vg:wmk.MetaVector)
+ constructor(private layout:ArrangeMixture, private vg:MetaVector)
{
this.measure = layout.measure;
this.policy = layout.policy;
@@ -61,7 +65,7 @@ export class DrawMixture
let px = [x1, xm - xd, xm, xm, xm, xm, xm + xd, x2];
let py = [y1, y1, y1, y1 - yd, y2 + yd, y2, y2, y2];
let lsz = this.scale * 0.1;
- this.vg.drawPath(px, py, [false, false, true, false, false, true, false, false], false, 0x000000, lsz, wmk.MetaVector.NOCOLOUR, false);
+ this.vg.drawPath(px, py, [false, false, true, false, false, true, false, false], false, 0x000000, lsz, MetaVector.NOCOLOUR, false);
}
private drawComponent(idx:number):void
@@ -77,7 +81,7 @@ export class DrawMixture
this.vg.drawRect(box.x, box.y, box.w, box.h, 0x808080, 1, bg);
- if (comp.molLayout) new wmk.DrawMolecule(comp.molLayout, this.vg).draw();
+ if (comp.molLayout) new DrawMolecule(comp.molLayout, this.vg).draw();
if (comp.nameLines.length > 0)
{
@@ -85,7 +89,7 @@ export class DrawMixture
for (let line of comp.nameLines)
{
let wad = this.measure.measureText(line.text, comp.fontSize);
- this.vg.drawText(x, y, line.text, comp.fontSize, line.col, wmk.TextAlign.Centre | wmk.TextAlign.Top);
+ this.vg.drawText(x, y, line.text, comp.fontSize, line.col, TextAlign.Centre | TextAlign.Top);
y += wad[1] + 2 * wad[2];
}
}
@@ -102,4 +106,3 @@ export class DrawMixture
}
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/EditComponent.ts b/src/mixture/EditComponent.ts
index c8a6bd0..0062548 100644
--- a/src/mixture/EditComponent.ts
+++ b/src/mixture/EditComponent.ts
@@ -10,7 +10,22 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {Chemistry} from '../../wmk/data/Chemistry';
+import {MoleculeStream} from '../../wmk/data/MoleculeStream';
+import {MolUtil} from '../../wmk/data/MolUtil';
+import {OntologyTree} from '../../wmk/data/OntologyTree';
+import {Dialog} from '../../wmk/dialog/Dialog';
+import {ClipboardProxy, ClipboardProxyHandler} from '../../wmk/ui/ClipboardProxy';
+import {OptionList} from '../../wmk/ui/OptionList';
+import {dom, DOM} from '../../wmk/util/dom';
+import {deepClone} from '../../wmk/util/util';
+import {Vec} from '../../wmk/util/Vec';
+import {MixfileComponent} from '../data/Mixfile';
+import {Mixture} from '../data/Mixture';
+import {Units} from '../data/Units';
+import {InChI} from '../main/InChI';
+import {KeyValueWidget} from './KeyValueWidget';
+import {MetadataWidget} from './MetadataWidget';
/*
High level widget for the editing area for a mixture.
@@ -25,9 +40,9 @@ enum QuantityType
const RELATION_VALUES:string[] = ['=', '~', '<', '<=', '>', '>='];
const RELATION_LABELS:string[] = ['=', '~', '<', '≤', '>', '≥'];
-export class EditComponent extends wmk.Dialog
+export class EditComponent extends Dialog
{
- public proxyClip:wmk.ClipboardProxy = null;
+ public proxyClip:ClipboardProxy = null;
private component:MixfileComponent;
@@ -37,9 +52,9 @@ export class EditComponent extends wmk.Dialog
private btnCopy:DOM;
private btnSave:DOM;
- //private sketcher:wmk.Sketcher;
+ //private sketcher:Sketcher;
private lineName:DOM;
- private optQuantType:wmk.OptionList;
+ private optQuantType:OptionList;
private dropQuantRel:DOM;
private lineQuantVal1:DOM;
private lineQuantVal2:DOM;
@@ -86,7 +101,7 @@ export class EditComponent extends wmk.Dialog
// builds the dialog content
protected populate():void
{
- if (this.proxyClip) this.proxyClip.pushHandler(new wmk.ClipboardProxyHandler());
+ if (this.proxyClip) this.proxyClip.pushHandler(new ClipboardProxyHandler());
let buttons = this.buttonsDOM(), body = this.bodyDOM();
@@ -180,7 +195,7 @@ export class EditComponent extends wmk.Dialog
});
editLinks.render(dom('<div/>').appendTo(grid2).css({'grid-area': `${row} / value`}));
- if (wmk.OntologyTree.main && wmk.OntologyTree.main.getRoots().length > 0)
+ if (OntologyTree.main && OntologyTree.main.getRoots().length > 0)
{
this.createFieldName(grid2, ++row, 'Metadata', true);
let editMetadata = new MetadataWidget(this.component.metadata, (metadata) =>
@@ -350,7 +365,7 @@ export class EditComponent extends wmk.Dialog
flex.css({'display': 'flex', 'align-items': 'center'});
let box = ():DOM => dom('<div style="padding-left: 0.5em;"/>').appendTo(flex);
- this.optQuantType = new wmk.OptionList([QuantityType.Value, QuantityType.Range, QuantityType.Ratio]);
+ this.optQuantType = new OptionList([QuantityType.Value, QuantityType.Range, QuantityType.Ratio]);
this.optQuantType.render(flex);
this.dropQuantRel = this.makeDropdownGroup(box(), this.component.relation, RELATION_VALUES, RELATION_LABELS,
@@ -525,8 +540,8 @@ export class EditComponent extends wmk.Dialog
{
if (!InChI.isAvailable()) return;
//let mol = this.sketcher.getMolecule();
- let mol = wmk.MoleculeStream.readUnknown(this.component.molfile);
- if (wmk.MolUtil.isBlank(mol))
+ let mol = MoleculeStream.readUnknown(this.component.molfile);
+ if (MolUtil.isBlank(mol))
{
//alert('Draw a molecule first, then calculate the InChI.');
return;
@@ -544,10 +559,10 @@ export class EditComponent extends wmk.Dialog
private calculateFormula():string
{
if (!this.component.molfile) return '';
- let mol = wmk.MoleculeStream.readUnknown(this.component.molfile);
- if (wmk.MolUtil.isBlank(mol)) return '';
+ let mol = MoleculeStream.readUnknown(this.component.molfile);
+ if (MolUtil.isBlank(mol)) return '';
for (let n = mol.numAtoms; n >= 1; n--) if (mol.atomicNumber(n) == 0) mol.deleteAtomAndBonds(n);
- return wmk.MolUtil.molecularFormula(mol);
+ return MolUtil.molecularFormula(mol);
}
// derive from MF field, if any
@@ -562,7 +577,7 @@ export class EditComponent extends wmk.Dialog
{
let match = mf.match(/^([A-Z][a-z]?)(\d*)(.*?)$/);
if (!match) {mw = 0; break;}
- let atno = wmk.Chemistry.ELEMENTS.indexOf(match[1]);
+ let atno = Chemistry.ELEMENTS.indexOf(match[1]);
if (atno <= 0) {mw = 0; break;}
let num = 1;
if (match[2])
@@ -570,7 +585,7 @@ export class EditComponent extends wmk.Dialog
num = parseInt(match[2]);
if (num <= 0) {mw = 0; break;}
}
- mw += wmk.Chemistry.NATURAL_ATOMIC_WEIGHTS[atno] * num;
+ mw += Chemistry.NATURAL_ATOMIC_WEIGHTS[atno] * num;
mf = match[3];
}
@@ -586,5 +601,3 @@ export class EditComponent extends wmk.Dialog
}
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/EditMixture.ts b/src/mixture/EditMixture.ts
index 00276a2..82c25ea 100644
--- a/src/mixture/EditMixture.ts
+++ b/src/mixture/EditMixture.ts
@@ -10,7 +10,29 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {CoordUtil} from '../../wmk/data/CoordUtil';
+import {MDLMOLWriter} from '../../wmk/data/MDLWriter';
+import {Molecule} from '../../wmk/data/Molecule';
+import {MoleculeStream} from '../../wmk/data/MoleculeStream';
+import {MolUtil} from '../../wmk/data/MolUtil';
+import {EditCompound} from '../../wmk/dialog/EditCompound';
+import {OutlineMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {MetaVector} from '../../wmk/gfx/MetaVector';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {ClipboardProxy} from '../../wmk/ui/ClipboardProxy';
+import {MenuProxy} from '../../wmk/ui/MenuProxy';
+import {Widget} from '../../wmk/ui/Widget';
+import {Box, Size} from '../../wmk/util/Geom';
+import {deepClone, eventCoords, newElement, pixelDensity} from '../../wmk/util/util';
+import {Vec} from '../../wmk/util/Vec';
+import {MixfileComponent} from '../data/Mixfile';
+import {Mixture} from '../data/Mixture';
+import {NormMixture} from '../data/NormMixture';
+import {ExtractCTABComponent} from '../lookup/ExtractCTABComponent';
+import {LookupCompoundDialog} from '../lookup/LookupCompoundDialog';
+import {ArrangeMixture} from './ArrangeMixture';
+import {DrawMixture} from './DrawMixture';
+import {EditComponent} from './EditComponent';
/*
High level widget for the editing area for a mixture.
@@ -26,13 +48,13 @@ enum DragReason
Pan,
}
-export class EditMixture extends wmk.Widget
+export class EditMixture extends Widget
{
public callbackUpdateTitle:() => void = null;
public callbackInteraction:() => void = null;
protected mixture = new Mixture();
- protected policy = wmk.RenderPolicy.defaultColourOnWhite();
+ protected policy = RenderPolicy.defaultColourOnWhite();
protected canvasMixture:HTMLCanvasElement;
protected canvasOver:HTMLCanvasElement;
@@ -56,13 +78,13 @@ export class EditMixture extends wmk.Widget
protected dragX = 0;
protected dragY = 0;
protected isEditing = false;
- protected dlgCompound:wmk.EditCompound = null;
+ protected dlgCompound:EditCompound = null;
protected structureIntegrity:Record<string, string> = {}; // metadata key -> name for those which are sensitive to changes to structure
// ------------ public methods ------------
- constructor(protected proxyClip:wmk.ClipboardProxy, protected proxyMenu:wmk.MenuProxy)
+ constructor(protected proxyClip:ClipboardProxy, protected proxyMenu:MenuProxy)
{
super();
}
@@ -107,7 +129,7 @@ export class EditMixture extends wmk.Widget
// whether or not menu commands are being received; no means that it's in dialog/editing mode
public isReceivingCommands():boolean {return !this.isEditing;}
public setEditing(isEditing:boolean):void {this.isEditing = isEditing;}
- public compoundEditor():wmk.EditCompound {return this.dlgCompound;}
+ public compoundEditor():EditCompound {return this.dlgCompound;}
// add a metadata key that can potentially stop being valid when the structure is changed
public addStructureIntegrityKey(key:string, description:string):void
@@ -250,16 +272,16 @@ export class EditMixture extends wmk.Widget
let origin = this.layout.components[this.selectedIndex].origin;
let comp = this.mixture.getComponent(origin);
- let mol = comp.molfile ? wmk.MoleculeStream.readUnknown(comp.molfile) : null;
+ let mol = comp.molfile ? MoleculeStream.readUnknown(comp.molfile) : null;
- this.dlgCompound = new wmk.EditCompound(mol ? mol : new wmk.Molecule(), this.contentDOM);
+ this.dlgCompound = new EditCompound(mol ? mol : new Molecule(), this.contentDOM);
this.dlgCompound.onSave(() =>
{
let mol = this.dlgCompound.getMolecule();
comp = deepClone(comp);
this.checkStructureIntegrity(comp, mol);
- let molfile = wmk.MoleculeStream.writeMDLMOL(mol);
+ let molfile = MoleculeStream.writeMDLMOL(mol);
if (!molfile) molfile = null;
comp.molfile = molfile;
@@ -334,7 +356,7 @@ export class EditMixture extends wmk.Widget
comp = deepClone(modmix.getComponent(origin));
let name = dlg.getName(), mol = dlg.getMolecule();
if (name != null) comp.name = name;
- if (mol != null) comp.molfile = new wmk.MDLMOLWriter(mol).write();
+ if (mol != null) comp.molfile = new MDLMOLWriter(mol).write();
if (modmix.setComponent(origin, comp))
{
this.setMixture(modmix);
@@ -476,14 +498,14 @@ export class EditMixture extends wmk.Widget
// see if it's just a regular singular molecule
if (!json)
{
- let mol = wmk.MoleculeStream.readUnknown(str);
- if (wmk.MolUtil.notBlank(mol))
+ let mol = MoleculeStream.readUnknown(str);
+ if (MolUtil.notBlank(mol))
{
let modmix = this.mixture.clone();
let comp = modmix.getComponent(origin);
if (comp)
{
- comp.molfile = new wmk.MDLMOLWriter(mol).write();
+ comp.molfile = new MDLMOLWriter(mol).write();
this.setMixture(modmix);
}
}
@@ -531,7 +553,7 @@ export class EditMixture extends wmk.Widget
}
// return the layout around onscreen for an indicated component
- public getComponentPosition(origin:number[]):wmk.Box
+ public getComponentPosition(origin:number[]):Box
{
for (let comp of this.layout.components) if (Vec.equals(origin, comp.origin))
{
@@ -562,13 +584,13 @@ export class EditMixture extends wmk.Widget
if (!this.layout)
{
- let measure = new wmk.OutlineMeasurement(0, 0, this.pointScale);
- let policy = new wmk.RenderPolicy(deepClone(this.policy.data));
+ let measure = new OutlineMeasurement(0, 0, this.pointScale);
+ let policy = new RenderPolicy(deepClone(this.policy.data));
policy.data.pointScale = this.pointScale;
this.layout = new ArrangeMixture(this.mixture, measure, policy);
this.layout.showCollapsors = true;
this.layout.collapsedBranches = this.collapsedBranches;
- this.layout.packBranches = new wmk.Size(0.8 * this.contentDOM.width(), 0.8 * this.contentDOM.height());
+ this.layout.packBranches = new Size(0.8 * this.contentDOM.width(), 0.8 * this.contentDOM.height());
this.layout.norm = new NormMixture(this.mixture);
this.layout.norm.analyse();
this.layout.arrange();
@@ -586,7 +608,7 @@ export class EditMixture extends wmk.Widget
this.delayedSelect = null;
}
- let gfx = new wmk.MetaVector();
+ let gfx = new MetaVector();
let draw = new DrawMixture(this.layout, gfx);
draw.hoverIndex = this.hoverIndex;
draw.activeIndex = this.activeIndex;
@@ -989,16 +1011,16 @@ export class EditMixture extends wmk.Widget
// given that the structure may have changed, see if any metadata is potentially invalidated - and ask the user; the component parameter
// may be modified
- protected checkStructureIntegrity(comp:MixfileComponent, newMol:wmk.Molecule):void
+ protected checkStructureIntegrity(comp:MixfileComponent, newMol:Molecule):void
{
let integKeys = Object.keys(this.structureIntegrity).filter((key) => (comp.identifiers && comp.identifiers[key]) || (comp.links && comp.links[key]));
if (integKeys.length == 0) return;
- let oldMol = comp.molfile ? wmk.MoleculeStream.readUnknown(comp.molfile) : null;
- if (wmk.MolUtil.isBlank(oldMol) && wmk.MolUtil.isBlank(newMol)) return;
- if (oldMol && newMol && wmk.CoordUtil.sketchMappable(oldMol, newMol)) return;
+ let oldMol = comp.molfile ? MoleculeStream.readUnknown(comp.molfile) : null;
+ if (MolUtil.isBlank(oldMol) && MolUtil.isBlank(newMol)) return;
+ if (oldMol && newMol && CoordUtil.sketchMappable(oldMol, newMol)) return;
- let msg = wmk.MolUtil.isBlank(newMol) ? 'Structure has been removed.' : 'Structure has changed.';
+ let msg = MolUtil.isBlank(newMol) ? 'Structure has been removed.' : 'Structure has changed.';
msg += `\nThe following reference${integKeys.length == 1 ? '' : 's'} may have become stale:`;
for (let key of integKeys) msg += '\n ' + this.structureIntegrity[key];
msg += integKeys.length == 1 ? '\nRemove this reference?' : '\nRemove these references?';
@@ -1011,5 +1033,3 @@ export class EditMixture extends wmk.Widget
}
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/ExportMInChI.ts b/src/mixture/ExportMInChI.ts
index 6918544..2358fdb 100644
--- a/src/mixture/ExportMInChI.ts
+++ b/src/mixture/ExportMInChI.ts
@@ -10,7 +10,16 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {Molecule} from '../../wmk/data/Molecule';
+import {MoleculeStream} from '../../wmk/data/MoleculeStream';
+import {MolUtil} from '../../wmk/data/MolUtil';
+import {deepClone} from '../../wmk/util/util';
+import {Vec} from '../../wmk/util/Vec';
+import {Mixfile, MixfileComponent} from '../data/Mixfile';
+import {Mixture} from '../data/Mixture';
+import {NormMixture, NormMixtureNote} from '../data/NormMixture';
+import {Units} from '../data/Units';
+import {InChI} from '../main/InChI';
// quick implementation of CRC hash codes
let crc_table:number[] = [];
@@ -91,10 +100,10 @@ export class ExportMInChI
for (let comp of this.mixture.getComponents())
{
if (!comp.molfile || comp.inchi) continue;
- let mol:wmk.Molecule = null;
- try {mol = wmk.MoleculeStream.readUnknown(comp.molfile);}
+ let mol:Molecule = null;
+ try {mol = MoleculeStream.readUnknown(comp.molfile);}
catch (e) {continue;} // silent failure if it's an invalid molecule
- if (wmk.MolUtil.isBlank(mol)) continue;
+ if (MolUtil.isBlank(mol)) continue;
let [inchi, inchiKey] = await InChI.makeInChI(mol);
comp.inchi = inchi;
comp.inchiKey = inchiKey;
@@ -387,4 +396,3 @@ export class ExportMInChI
}
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/ExportSDFile.ts b/src/mixture/ExportSDFile.ts
index 842b51b..6fd2b88 100644
--- a/src/mixture/ExportSDFile.ts
+++ b/src/mixture/ExportSDFile.ts
@@ -10,7 +10,13 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {DataSheet, DataSheetColumn} from '../../wmk/data/DataSheet';
+import {MDLMOLReader} from '../../wmk/data/MDLReader';
+import {MDLSDFWriter} from '../../wmk/data/MDLWriter';
+import {Molecule} from '../../wmk/data/Molecule';
+import {Vec} from '../../wmk/util/Vec';
+import {Mixfile, MixfileComponent} from '../data/Mixfile';
+import {ExportMInChI} from './ExportMInChI';
/*
Interoperability with SDfiles: conversion of the Mixfile hierarchy into a flattened SDfile is useful for presenting to
@@ -19,7 +25,7 @@ namespace Mixtures /* BOF */ {
export class ExportSDFile
{
- private ds = new wmk.DataSheet();
+ private ds = new DataSheet();
private colMol:number;
private colName:number;
private colHier:number;
@@ -29,10 +35,10 @@ export class ExportSDFile
constructor()
{
- this.colMol = this.ds.appendColumn('Molecule', wmk.DataSheetColumn.Molecule, '');
- this.colName = this.ds.appendColumn('Name', wmk.DataSheetColumn.String, '');
- this.colHier = this.ds.appendColumn('MINCHI$N', wmk.DataSheetColumn.String, '');
- this.colConc = this.ds.appendColumn('MINCHI$C', wmk.DataSheetColumn.String, '');
+ this.colMol = this.ds.appendColumn('Molecule', DataSheetColumn.Molecule, '');
+ this.colName = this.ds.appendColumn('Name', DataSheetColumn.String, '');
+ this.colHier = this.ds.appendColumn('MINCHI$N', DataSheetColumn.String, '');
+ this.colConc = this.ds.appendColumn('MINCHI$C', DataSheetColumn.String, '');
}
// can add any number of mixtures, which will be numbered automatically
@@ -53,7 +59,7 @@ export class ExportSDFile
// return the SDF-serialised representation
public write():string
{
- return new wmk.MDLSDFWriter(this.ds).write();
+ return new MDLSDFWriter(this.ds).write();
}
// ------------ private methods ------------
@@ -63,20 +69,20 @@ export class ExportSDFile
{
let row = this.ds.appendRow();
- let mol:wmk.Molecule = null;
+ let mol:Molecule = null;
if (comp.molfile)
{
- mol = wmk.Molecule.fromString(comp.molfile);
+ mol = Molecule.fromString(comp.molfile);
if (!mol)
{
try
{
- mol = new wmk.MDLMOLReader(comp.molfile).parse();
+ mol = new MDLMOLReader(comp.molfile).parse();
}
catch (e) {}
}
}
- if (!mol) mol = new wmk.Molecule();
+ if (!mol) mol = new Molecule();
this.ds.setMolecule(row, this.colMol, mol);
if (comp.name) this.ds.setString(row, this.colName, comp.name);
@@ -134,5 +140,3 @@ export class ExportSDFile
return ExportMInChI.formatConcentration(comp.quantity, comp.error, useRatio, comp.units, comp.relation);
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/ImportSDFile.ts b/src/mixture/ImportSDFile.ts
index fa1735c..9bc7c23 100644
--- a/src/mixture/ImportSDFile.ts
+++ b/src/mixture/ImportSDFile.ts
@@ -10,7 +10,14 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {DataSheetColumn} from '../../wmk/data/DataSheet';
+import {MDLSDFReader} from '../../wmk/data/MDLReader';
+import {MDLMOLWriter} from '../../wmk/data/MDLWriter';
+import {Molecule} from '../../wmk/data/Molecule';
+import {Vec} from '../../wmk/util/Vec';
+import {Mixfile, MixfileComponent} from '../data/Mixfile';
+import {Mixture} from '../data/Mixture';
+import {StandardUnits, Units} from '../data/Units';
/*
Importing one or more mixtures from chunks of text that represent an SDfile with special mixture fields.
@@ -18,7 +25,7 @@ namespace Mixtures /* BOF */ {
interface ImportComponent
{
- mol:wmk.Molecule;
+ mol:Molecule;
name:string;
conc:string;
hier:string;
@@ -69,11 +76,11 @@ export class ImportSDFile
// have identified one SDfile record (ending in $$$$), so carve it up into an upcoming component
private processBlock(sdfile:string):void
{
- let reader = new wmk.MDLSDFReader(sdfile);
+ let reader = new MDLSDFReader(sdfile);
reader.upcastColumns = false;
let ds = reader.parse();
if (!ds || ds.numRows == 0) return;
- let colMol = ds.firstColOfType(wmk.DataSheetColumn.Molecule);
+ let colMol = ds.firstColOfType(DataSheetColumn.Molecule);
let colName = ds.findColByName('Name');
let colHier = ds.findColByName('MINCHI$N');
let colConc = ds.findColByName('MINCHI$C');
@@ -95,7 +102,7 @@ export class ImportSDFile
for (let incomp of this.components)
{
- let molfile = incomp.mol ? new wmk.MDLMOLWriter(incomp.mol).write() : undefined;
+ let molfile = incomp.mol ? new MDLMOLWriter(incomp.mol).write() : undefined;
let origin = incomp.hier.split('.').map((str) => parseInt(str) - 1);
let idx = origin.pop();
let parent = mixture.getComponent(origin);
@@ -184,5 +191,3 @@ export class ImportSDFile
}
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/KeyValueWidget.ts b/src/mixture/KeyValueWidget.ts
index 20a3058..2303010 100644
--- a/src/mixture/KeyValueWidget.ts
+++ b/src/mixture/KeyValueWidget.ts
@@ -10,7 +10,8 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {Widget} from '../../wmk/ui/Widget';
+import {dom, DOM} from '../../wmk/util/dom';
/*
Widget for editing a key/value pattern, whereby key/value pairs can be added and edited individually.
@@ -24,7 +25,7 @@ interface KeyValueWidgetLine
inputValue?:DOM;
}
-export class KeyValueWidget extends wmk.Widget
+export class KeyValueWidget extends Widget
{
private lines:KeyValueWidgetLine[] = [];
@@ -121,5 +122,3 @@ export class KeyValueWidget extends wmk.Widget
this.callbackChange(dict);
}
}
-
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/MetadataWidget.ts b/src/mixture/MetadataWidget.ts
index 23ea07c..5570488 100644
--- a/src/mixture/MetadataWidget.ts
+++ b/src/mixture/MetadataWidget.ts
@@ -10,7 +10,15 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {OntologyTree, OntologyTreeTerm} from '../../wmk/data/OntologyTree';
+import {Popup} from '../../wmk/ui/Popup';
+import {addTooltip, clearTooltip} from '../../wmk/ui/Tooltip';
+import {Widget} from '../../wmk/ui/Widget';
+import {dom, DOM} from '../../wmk/util/dom';
+import {hasInlineCSS, installInlineCSS} from '../../wmk/util/Theme';
+import {escapeHTML} from '../../wmk/util/util';
+import {Vec} from '../../wmk/util/Vec';
+import {MixfileMetadatum} from '../data/Mixfile';
/*
Widget for editing a list of metadata items.
@@ -29,7 +37,7 @@ interface MetadataWidgetLine
datum:MixfileMetadatum;
}
-export class MetadataWidget extends wmk.Widget
+export class MetadataWidget extends Widget
{
private lines:MetadataWidgetLine[] = [];
@@ -43,7 +51,7 @@ export class MetadataWidget extends wmk.Widget
if (metadata) for (let datum of metadata) this.lines.push({'datum': datum});
- if (!wmk.hasInlineCSS('metadatawidget')) wmk.installInlineCSS('metadatawidget', CSS_METADATAWIDGET);
+ if (!hasInlineCSS('metadatawidget')) installInlineCSS('metadatawidget', CSS_METADATAWIDGET);
}
public render(parent:any):void
@@ -71,11 +79,11 @@ export class MetadataWidget extends wmk.Widget
if (typeof item == 'string')
{
div.css({'background-color': idx == 0 ? '#D0D0D0' : '#D0D0FF', 'border-radius': '3px'});
- let branch = wmk.OntologyTree.main.getBranch(item);
+ let branch = OntologyTree.main.getBranch(item);
if (Vec.notBlank(branch))
{
div.setText(branch[0].label);
- wmk.addTooltip(div, escapeHTML(branch[0].uri), null, 1000);
+ addTooltip(div, escapeHTML(branch[0].uri), null, 1000);
}
else div.setText(item);
}
@@ -165,10 +173,10 @@ export class MetadataWidget extends wmk.Widget
private pickNewTerm(divParent:DOM):void
{
- let branchList:wmk.OntologyTreeTerm[] = [];
+ let branchList:OntologyTreeTerm[] = [];
const ROOTS = ['http://mixtures.io/rdf#MixtureMetadata'];
- for (let rootURI of ROOTS) branchList.push(...wmk.OntologyTree.main.getBranchList(rootURI));
- let popup = new wmk.Popup(divParent);
+ for (let rootURI of ROOTS) branchList.push(...OntologyTree.main.getBranchList(rootURI));
+ let popup = new Popup(divParent);
popup.callbackPopulate = () =>
{
this.populateBranch(popup, branchList, (term) =>
@@ -183,11 +191,11 @@ export class MetadataWidget extends wmk.Widget
private pickExtraTerm(divParent:DOM, line:MetadataWidgetLine, isProperty:boolean):void
{
- let branchList:wmk.OntologyTreeTerm[] = [];
+ let branchList:OntologyTreeTerm[] = [];
const ROOTS_ASSERT = ['http://mixtures.io/rdf#MixtureMetadata'];
const ROOTS_PROP = ['http://purl.obolibrary.org/obo/UO_0000000'];
- for (let rootURI of (isProperty ? ROOTS_PROP : ROOTS_ASSERT)) branchList.push(...wmk.OntologyTree.main.getBranchList(rootURI));
- let popup = new wmk.Popup(divParent);
+ for (let rootURI of (isProperty ? ROOTS_PROP : ROOTS_ASSERT)) branchList.push(...OntologyTree.main.getBranchList(rootURI));
+ let popup = new Popup(divParent);
popup.callbackPopulate = () =>
{
this.populateBranch(popup, branchList, (term) =>
@@ -203,7 +211,7 @@ export class MetadataWidget extends wmk.Widget
}
// enumerates a list of clickable ontology tree items
- private populateBranch(popup:wmk.Popup, branchList:wmk.OntologyTreeTerm[], callbackClicked:(term:wmk.OntologyTreeTerm) => void):void
+ private populateBranch(popup:Popup, branchList:OntologyTreeTerm[], callbackClicked:(term:OntologyTreeTerm) => void):void
{
let body = popup.bodyDOM();
@@ -217,10 +225,10 @@ export class MetadataWidget extends wmk.Widget
}
let span = dom('<span/>').appendTo(div).class('wmk-metadataitem');
span.setText(term.label);
- wmk.addTooltip(span, escapeHTML(term.uri), null, 2000);
+ addTooltip(span, escapeHTML(term.uri), null, 2000);
span.onClick(() =>
{
- wmk.clearTooltip();
+ clearTooltip();
popup.close();
callbackClicked(term);
});
@@ -228,4 +236,3 @@ export class MetadataWidget extends wmk.Widget
}
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/mixture/SquarePacking.ts b/src/mixture/SquarePacking.ts
index abfddfb..2a325be 100644
--- a/src/mixture/SquarePacking.ts
+++ b/src/mixture/SquarePacking.ts
@@ -10,7 +10,8 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {Box, Size} from '../../wmk/util/Geom';
+import {Vec} from '../../wmk/util/Vec';
/*
Try to arrange a list of boxes into a more rectangular pattern, which has a better ratio than stacking everything vertically.
@@ -27,8 +28,8 @@ interface SquarePackingCandidate
{
idxStart:number;
springs:SquarePackingSpring[];
- layout?:wmk.Box[];
- outline?:wmk.Size;
+ layout?:Box[];
+ outline?:Size;
score?:number; // lower is better
hash?:string;
}
@@ -42,15 +43,15 @@ interface SquarePackingSegment
export class SquarePacking
{
- public outline:wmk.Size;
- public layout:wmk.Box[] = null;
+ public outline:Size;
+ public layout:Box[] = null;
private wantRatio:number;
// --------------------- public methods ---------------------
// sets up the object with the mandatory information
- constructor(private packSize:wmk.Size, private boxes:wmk.Box[], private hspace:number, private vspace:number)
+ constructor(private packSize:Size, private boxes:Box[], private hspace:number, private vspace:number)
{
this.wantRatio = packSize.w / packSize.h;
@@ -128,7 +129,7 @@ export class SquarePacking
private processCandidate(cand:SquarePackingCandidate):void
{
let len = this.boxes.length;
- cand.layout = this.boxes.map((box) => new wmk.Box(0, 0, box.w, box.h));
+ cand.layout = this.boxes.map((box) => new Box(0, 0, box.w, box.h));
let placed = Vec.booleanArray(false, len);
placed[cand.idxStart] = true;
@@ -206,7 +207,7 @@ export class SquarePacking
let loX = 0, hiX = Vec.max(cand.layout.map((box) => box.maxX()));
let loY = Vec.min(cand.layout.map((box) => box.minY())), hiY = Vec.max(cand.layout.map((box) => box.maxY()));
- cand.outline = new wmk.Size(hiX - loX, hiY - loY);
+ cand.outline = new Size(hiX - loX, hiY - loY);
let ratio = cand.outline.w / cand.outline.h;
cand.score = Math.abs(ratio - this.wantRatio) * (cand.outline.w + cand.outline.h);
cand.score += Vec.sum((cand.layout.map((box) => box.x)));
@@ -269,4 +270,3 @@ export class SquarePacking
}
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/startup.ts b/src/startup.ts
index 80f6e72..a67e193 100644
--- a/src/startup.ts
+++ b/src/startup.ts
@@ -10,13 +10,18 @@
Made available under the Gnu Public License v3.0
*/
-///<reference path='decl/node.d.ts'/>
-///<reference path='main/MixturePanel.ts'/>
-
-namespace Mixtures /* BOF */ {
+import {MainPanel} from './main/MainPanel';
+import {MixturePanel} from './main/MixturePanel';
+import {initWebMolKit, Theme} from '../wmk/util/Theme';
+import {DOM} from '../wmk/util/dom';
+import {OntologyTree} from '../wmk/data/OntologyTree';
+import {CollectionPanel} from './main/CollectionPanel';
+import {ClipboardProxy} from '../wmk/ui/ClipboardProxy';
+import {MenuProxy, MenuProxyContext} from '../wmk/ui/MenuProxy';
export let ON_DESKTOP = false; // by default assume it's running in a regular web page; switch to true if it's the locally
// executed window version
+export function setOnDesktop(value:boolean) {ON_DESKTOP = value;}
/*
Startup: gets the ball rolling, and provide some high level window handling.
@@ -27,9 +32,9 @@ export async function runMixfileEditor(resURL:string, rootID:string):Promise<voi
let root = DOM.find('#' + rootID);
ON_DESKTOP = true;
- wmk.initWebMolKit(resURL);
- await wmk.OntologyTree.init();
- await wmk.OntologyTree.main.loadFromURL(resURL + '/data/ontology/metacategory.onto');
+ initWebMolKit(resURL);
+ await OntologyTree.init();
+ await OntologyTree.main.loadFromURL(resURL + '/data/ontology/metacategory.onto');
// node/electron imports; note these are defined inside the function so as not to perturb normal web-access, which does not
// include these libraries
@@ -41,7 +46,7 @@ export async function runMixfileEditor(resURL:string, rootID:string):Promise<voi
process.env['ELECTRON_DISABLE_SECURITY_WARNINGS'] = true;
let url = window.location.href.substring(0, window.location.href.lastIndexOf('/'));
- wmk.Theme.RESOURCE_URL = path.normalize(url + '/res');
+ Theme.RESOURCE_URL = path.normalize(url + '/res');
// unpack web params: if present, they determine where to go from here
let params = window.location.search.substring(1).split('&');
@@ -58,7 +63,7 @@ export async function runMixfileEditor(resURL:string, rootID:string):Promise<voi
if (!panelClass && filename && filename.endsWith('.json')) panelClass = 'CollectionPanel';
- let proxyClip = new wmk.ClipboardProxy();
+ let proxyClip = new ClipboardProxy();
const {clipboard} = electron;
proxyClip.getString = ():string => clipboard.readText();
proxyClip.setString = (str:string):void => clipboard.writeText(str);
@@ -66,11 +71,11 @@ export async function runMixfileEditor(resURL:string, rootID:string):Promise<voi
proxyClip.canSetHTML = ():boolean => true;
proxyClip.canAlwaysGet = ():boolean => true;
- let proxyMenu = new wmk.MenuProxy();
+ let proxyMenu = new MenuProxy();
proxyMenu.hasContextMenu = () => true;
- proxyMenu.openContextMenu = (menuItems:wmk.MenuProxyContext[], event:MouseEvent) =>
+ proxyMenu.openContextMenu = (menuItems:MenuProxyContext[], event:MouseEvent) =>
{
- let populate = (emenu:Electron.Menu, itemList:wmk.MenuProxyContext[]):void =>
+ let populate = (emenu:Electron.Menu, itemList:MenuProxyContext[]):void =>
{
for (let item of itemList)
{
@@ -92,16 +97,16 @@ export async function runMixfileEditor(resURL:string, rootID:string):Promise<voi
};
let main:MainPanel;
- if (!panelClass)
- {
- let dw = main = new MixturePanel(root, proxyClip, proxyMenu);
- }
- else
+ if (!panelClass || panelClass == 'MixturePanel') main = new MixturePanel(root, proxyClip, proxyMenu);
+ else if (panelClass == 'CollectionPanel') main = new CollectionPanel(root, proxyClip, proxyMenu);
+ else throw 'Unexpected class:' + panelClass;
+
+ /*
{
let proto = (Mixtures as any)[panelClass];
if (!proto) throw 'Unknown class: ' + panelClass;
main = new (proto as any)(root, proxyClip, proxyMenu);
- }
+ }*/
main.loadFile(filename);
@@ -124,5 +129,3 @@ export function openNewWindow(panelClass:string, filename?:string):void
bw.loadURL(url);
/*bw.on('closed', function() {bw = null;});*/
}
-
-/* EOF */ }
diff --git a/src/web/EditMixtureWeb.ts b/src/web/EditMixtureWeb.ts
index 119023c..ddc4f08 100644
--- a/src/web/EditMixtureWeb.ts
+++ b/src/web/EditMixtureWeb.ts
@@ -10,9 +10,14 @@
Made available under the Gnu Public License v3.0
*/
-///<reference path='../mixture/EditMixture.ts'/>
-
-namespace Mixtures /* BOF */ {
+import {CoordUtil} from '../../wmk/data/CoordUtil';
+import {Molecule} from '../../wmk/data/Molecule';
+import {MoleculeStream} from '../../wmk/data/MoleculeStream';
+import {ClipboardProxy} from '../../wmk/ui/ClipboardProxy';
+import {MenuProxy, MenuProxyContext} from '../../wmk/ui/MenuProxy';
+import {deepClone, eventCoords} from '../../wmk/util/util';
+import {Vec} from '../../wmk/util/Vec';
+import {EditMixture} from '../mixture/EditMixture';
/*
Modified version of the EditMixture class that replaces the default Electron desktop functionality
@@ -22,20 +27,20 @@ namespace Mixtures /* BOF */ {
export class EditMixtureWeb extends EditMixture
{
public callbackLookup:(editor:EditMixtureWeb) => void = null; // optional: added to context menu if defined
- public callbackStructureEditor:(mol:wmk.Molecule, onSuccess:(mol:wmk.Molecule) => void) => void = null; // optional editor replacement
+ public callbackStructureEditor:(mol:Molecule, onSuccess:(mol:Molecule) => void) => void = null; // optional editor replacement
public callbackFreeformKey:(edit:EditMixture, event:KeyboardEvent) => void = null;
private isMacKeyboard:boolean;
// ------------ public methods ------------
- constructor(proxyClip:wmk.ClipboardProxy, proxyMenu?:wmk.MenuProxy)
+ constructor(proxyClip:ClipboardProxy, proxyMenu?:MenuProxy)
{
super(proxyClip, proxyMenu);
// the 'navigator' object is being overhauled: it should have a more structured userAgentData property on most browsers; if not it
// falls back to the older .platform property, which will trigger a deprecation warning on a browser; but for Electron context, it's OK
- let nav = navigator as any;
+ let nav = navigator as any;
this.isMacKeyboard = nav.userAgentData ? nav.userAgentData.platform == 'macOS' : nav.platform.startsWith('Mac');
}
@@ -58,7 +63,7 @@ export class EditMixtureWeb extends EditMixture
this.activeIndex = -1;
this.delayedRedraw();
- let menu:wmk.MenuProxyContext[] = [];
+ let menu:MenuProxyContext[] = [];
if (idx >= 0)
{
@@ -176,7 +181,7 @@ export class EditMixtureWeb extends EditMixture
if (this.selectedIndex < 0) return;
let origin = this.layout.components[this.selectedIndex].origin;
let comp = this.mixture.getComponent(origin);
- let mol = comp.molfile ? wmk.MoleculeStream.readUnknown(comp.molfile) : null;
+ let mol = comp.molfile ? MoleculeStream.readUnknown(comp.molfile) : null;
this.isEditing = true;
this.callbackStructureEditor(mol, (mol) =>
@@ -186,8 +191,8 @@ export class EditMixtureWeb extends EditMixture
comp = deepClone(comp);
this.checkStructureIntegrity(comp, mol);
- wmk.CoordUtil.normaliseBondDistances(mol);
- let molfile = mol && mol.numAtoms > 0 ? wmk.MoleculeStream.writeMDLMOL(mol) : undefined;
+ CoordUtil.normaliseBondDistances(mol);
+ let molfile = mol && mol.numAtoms > 0 ? MoleculeStream.writeMDLMOL(mol) : undefined;
if (!molfile) molfile = null;
comp.molfile = molfile;
@@ -201,4 +206,3 @@ export class EditMixtureWeb extends EditMixture
}
}
-/* EOF */ }
\ No newline at end of file
diff --git a/src/web/WebWidget.ts b/src/web/WebWidget.ts
index 9c08ee4..3e96629 100644
--- a/src/web/WebWidget.ts
+++ b/src/web/WebWidget.ts
@@ -10,7 +10,27 @@
Made available under the Gnu Public License v3.0
*/
-namespace Mixtures /* BOF */ {
+import {MDLMOLReader} from '../../wmk/data/MDLReader';
+import {MDLMOLWriter} from '../../wmk/data/MDLWriter';
+import {Molecule} from '../../wmk/data/Molecule';
+import {OutlineMeasurement} from '../../wmk/gfx/ArrangeMeasurement';
+import {FontData} from '../../wmk/gfx/FontData';
+import {MetaVector} from '../../wmk/gfx/MetaVector';
+import {RenderPolicy} from '../../wmk/gfx/Rendering';
+import {ClipboardProxy, ClipboardProxyHandler, ClipboardProxyWeb} from '../../wmk/ui/ClipboardProxy';
+import {MenuProxy, MenuProxyWeb} from '../../wmk/ui/MenuProxy';
+import {Widget} from '../../wmk/ui/Widget';
+import {dom, DOM} from '../../wmk/util/dom';
+import {Box} from '../../wmk/util/Geom';
+import {installInlineCSS} from '../../wmk/util/Theme';
+import {deepClone} from '../../wmk/util/util';
+import {Mixture} from '../data/Mixture';
+import {MenuBanner, MenuBannerButton, MenuBannerCommand} from '../main/MenuBanner';
+import {ArrangeMixture} from '../mixture/ArrangeMixture';
+import {DrawMixture} from '../mixture/DrawMixture';
+import {EditMixture} from '../mixture/EditMixture';
+import {ExportSDFile} from '../mixture/ExportSDFile';
+import {EditMixtureWeb} from './EditMixtureWeb';
/*
A pure web entrypoint into the Mixfile Editor, which does not rely on Electron. It can be embedded into any regular web page.
@@ -76,7 +96,7 @@ interface WebWidgetPopover
textLines:string[]; // some number of lines to show
}
-export class WebWidget extends wmk.Widget
+export class WebWidget extends Widget
{
public callbackGoBack:() => void = null; // optional: gets an icon if defined
public callbackLookup:(editor:EditMixtureWeb) => void = null; // optional: gets an icon if defined
@@ -95,25 +115,25 @@ export class WebWidget extends wmk.Widget
// ------------ public methods ------------
- constructor(public proxyClip?:wmk.ClipboardProxy, public proxyMenu?:wmk.MenuProxy)
+ constructor(public proxyClip?:ClipboardProxy, public proxyMenu?:MenuProxy)
{
super();
- if (!this.proxyClip) this.proxyClip = new wmk.ClipboardProxyWeb();
- if (!this.proxyMenu) this.proxyMenu = new wmk.MenuProxyWeb();
+ if (!this.proxyClip) this.proxyClip = new ClipboardProxyWeb();
+ if (!this.proxyMenu) this.proxyMenu = new MenuProxyWeb();
// the 'navigator' object is being overhauled: it should have a more structured userAgentData property on most browsers; if not it
// falls back to the older .platform property, which will trigger a deprecation warning on a browser; but for Electron context, it's OK
- let nav = navigator as any;
+ let nav = navigator as any;
this.isMacKeyboard = nav.userAgentData ? nav.userAgentData.platform == 'macOS' : nav.platform.startsWith('Mac');
- let handler = new wmk.ClipboardProxyHandler();
- handler.copyEvent = (andCut:boolean, proxy:wmk.ClipboardProxy):boolean =>
+ let handler = new ClipboardProxyHandler();
+ handler.copyEvent = (andCut:boolean, proxy:ClipboardProxy):boolean =>
{
this.menuAction(andCut ? MenuBannerCommand.Cut : MenuBannerCommand.Copy);
return true;
};
- handler.pasteEvent = (proxy:wmk.ClipboardProxy):boolean =>
+ handler.pasteEvent = (proxy:ClipboardProxy):boolean =>
{
this.menuAction(MenuBannerCommand.Paste);
return true;
@@ -125,7 +145,7 @@ export class WebWidget extends wmk.Widget
{
super.render(parent);
- wmk.installInlineCSS('mixtures-webwidget', CSS_WIDGET);
+ installInlineCSS('mixtures-webwidget', CSS_WIDGET);
let content = this.contentDOM;
content.el.id = 'mixtureEditorWidget';
@@ -174,16 +194,16 @@ export class WebWidget extends wmk.Widget
if (this.callbackEditStructure)
{
- this.editor.callbackStructureEditor = (mol, callbackSuccess:(mol:wmk.Molecule) => void) =>
+ this.editor.callbackStructureEditor = (mol, callbackSuccess:(mol:Molecule) => void) =>
{
this.proxyClip.pushHandler(null);
- if (!mol) mol = new wmk.Molecule();
- let molfile = new wmk.MDLMOLWriter(mol).write();
+ if (!mol) mol = new Molecule();
+ let molfile = new MDLMOLWriter(mol).write();
this.editor.setEditing(true);
this.callbackEditStructure(molfile,
(molfile:string):void =>
{
- mol = molfile ? new wmk.MDLMOLReader(molfile).parse() : mol;
+ mol = molfile ? new MDLMOLReader(molfile).parse() : mol;
callbackSuccess(mol);
},
():void =>
@@ -302,12 +322,12 @@ export class WebWidget extends wmk.Widget
}
private actionExportSVG():void
{
- let policy = wmk.RenderPolicy.defaultColourOnWhite();
- let measure = new wmk.OutlineMeasurement(0, 0, policy.data.pointScale);
+ let policy = RenderPolicy.defaultColourOnWhite();
+ let measure = new OutlineMeasurement(0, 0, policy.data.pointScale);
let layout = new ArrangeMixture(this.editor.getMixture(), measure, policy);
layout.arrange();
- let gfx = new wmk.MetaVector();
+ let gfx = new MetaVector();
new DrawMixture(layout, gfx).draw();
gfx.normalise();
let svg = gfx.createSVG();
@@ -330,17 +350,17 @@ export class WebWidget extends wmk.Widget
{
if (!this.editor.getMixture().isEmpty() || !this.contentDOM) return;
- wmk.FontData.main.initNativeFont();
+ FontData.main.initNativeFont();
let divCover = dom('<div/>').appendTo(this.contentDOM).css({'grid-area': 'start / 1 / end / 1', 'pointer-events': 'none', 'z-index': '1000'}).class('mixtures-webwidget-overlay');
- setTimeout(() =>
+ setTimeout(() =>
{
if (divCover) divCover.addClass('mixtures-webwidget-overlay-fadein');
}, 200);
for (let popover of this.initialPopovers)
{
- let box:wmk.Box;
+ let box:Box;
if (popover.anchor)
{
box = this.banner.iconPosition(popover.anchor);
@@ -369,7 +389,7 @@ export class WebWidget extends wmk.Widget
this.editor.callbackInteraction = removeCover;
}
- private renderPopover(parent:DOM, avoidBox:wmk.Box, textLines:string[]):void
+ private renderPopover(parent:DOM, avoidBox:Box, textLines:string[]):void
{
const FONT = 'sans-serif', FSZ = 15;
@@ -378,7 +398,7 @@ export class WebWidget extends wmk.Widget
let textW = 0, ascent = 0, descent = 0;
for (let line of textLines)
{
- let wad = wmk.FontData.measureTextNative(line, FONT, FSZ);
+ let wad = FontData.measureTextNative(line, FONT, FSZ);
textW = Math.max(textW, wad[0]);
[ascent, descent] = [wad[1], wad[2]];
}
@@ -389,13 +409,13 @@ export class WebWidget extends wmk.Widget
let totalW = textW + 2 * PADDING, totalH = textH + 2 * PADDING + NIPPLEH;
- let box = new wmk.Box(avoidBox.midX() - 0.5 * totalW, avoidBox.maxY() + 2, totalW, totalH);
+ let box = new Box(avoidBox.midX() - 0.5 * totalW, avoidBox.maxY() + 2, totalW, totalH);
box.x = Math.min(outerW - totalW, Math.max(0, box.x));
let div = dom('<div/>').appendTo(parent).css({'position': 'absolute'});
div.setBoundaryPixels(box.x, box.y, box.w, box.h);
- let gfx = new wmk.MetaVector();
+ let gfx = new MetaVector();
gfx.setSize(totalW, totalH);
let nx = avoidBox.midX() - box.x;
@@ -430,4 +450,3 @@ export class WebWidget extends wmk.Widget
}
}
-/* EOF */ }
\ No newline at end of file
diff --git a/tsconfig.json b/tsconfig.json
index 81c17f0..c85d720 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -1,23 +1,22 @@
{
"compilerOptions":
{
- "module": "system",
+ "module": "es2020",
"noImplicitAny": true,
"removeComments": true,
"preserveConstEnums": true,
- "outFile": "app/mixfile.js",
+ "outDir": "dist",
"sourceMap": true,
"target": "ES6",
- "lib": ["es2019", "dom"],
- "types": []
+ "lib": ["es2020", "dom"],
+ "types": ["node", "electron"],
+ "declaration": true,
},
"include":
[
- // imported from WebMolKit
- "../WebMolKit/src/**/*.ts",
-
"src/*.ts",
- "src/**/*.ts"
+ "src/**/*.ts",
+ "wmk/**/*.ts",
],
"exclude":
[
@@ -25,4 +24,3 @@
"dist"
]
}
-
diff --git a/webpack-electron.config.js b/webpack-electron.config.js
new file mode 100644
index 0000000..5eec37e
--- /dev/null
+++ b/webpack-electron.config.js
@@ -0,0 +1,30 @@
+const path = require('path');
+
+module.exports =
+{
+ entry: './dist/index-electron.ts',
+ module:
+ {
+ rules:
+ [
+ {
+ test: /\.ts$/,
+ use: 'ts-loader',
+ exclude: /node_modules/,
+ },
+ ],
+ },
+ resolve:
+ {
+ extensions: ['.ts', '.js'],
+ },
+ output:
+ {
+ path: path.resolve(__dirname, 'app'),
+ filename: 'mixtures-electron.js',
+ sourceMapFilename: 'mixtures-electron.js.map',
+ library: 'Mixtures',
+ },
+ mode: 'development',
+ target: 'electron-main',
+};
\ No newline at end of file
diff --git a/webpack-web.config.js b/webpack-web.config.js
new file mode 100644
index 0000000..fde8827
--- /dev/null
+++ b/webpack-web.config.js
@@ -0,0 +1,30 @@
+const path = require('path');
+
+module.exports =
+{
+ entry: './dist/index-web.ts',
+ module:
+ {
+ rules:
+ [
+ {
+ test: /\.ts$/,
+ use: 'ts-loader',
+ exclude: /node_modules/,
+ },
+ ],
+ },
+ resolve:
+ {
+ extensions: ['.ts', '.js'],
+ },
+ output:
+ {
+ path: path.resolve(__dirname, 'app'),
+ filename: 'mixtures-web.js',
+ sourceMapFilename: 'mixtures-web.js.map',
+ library: 'Mixtures',
+ },
+ mode: 'development',
+ target: 'node',
+};
\ No newline at end of file
diff --git a/wmk b/wmk
new file mode 120000
index 0000000..433cc6b
--- /dev/null
+++ b/wmk
@@ -0,0 +1 @@
+../WebMolKit/src
\ No newline at end of file