mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-08-20 12:00:53 +08:00
Update opn typings for version 3.0.2
This commit is contained in:
+13
-5
@@ -1,10 +1,18 @@
|
||||
/// <reference path="opn.d.ts" />
|
||||
|
||||
import opn = require('opn');
|
||||
import * as opn from "opn";
|
||||
|
||||
var errorCallback: (err: Error) => void;
|
||||
|
||||
opn('foo');
|
||||
opn('foo', 'bar');
|
||||
opn('foo', errorCallback);
|
||||
opn('foo', 'bar', errorCallback);
|
||||
opn("foo");
|
||||
opn("foo", errorCallback);
|
||||
|
||||
opn("foo", { app: "bar" });
|
||||
opn("foo", { app: ["bar", "--arg"] });
|
||||
opn("foo", { app: "bar", wait: false });
|
||||
opn("foo", { app: ["bar", "--arg"] , wait: false});
|
||||
|
||||
opn("foo", { app: "bar" }, errorCallback);
|
||||
opn("foo", { app: ["bar", "--arg"] }, errorCallback);
|
||||
opn("foo", { app: "bar", wait: false }, errorCallback);
|
||||
opn("foo", { app: ["bar", "--arg"], wait: false }, errorCallback);
|
||||
|
||||
Vendored
+78
-6
@@ -1,10 +1,82 @@
|
||||
// Type definitions for opn 1.0.0
|
||||
// Type definitions for opn 3.0.2
|
||||
// Project: https://github.com/sindresorhus/opn
|
||||
// Definitions by: Shinnosuke Watanabe <https://github.com/shinnn>
|
||||
// Definitions by: Shinnosuke Watanabe <https://github.com/shinnn>,
|
||||
// Maxime LUCE <https://github.com/SomaticIT>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
declare module 'opn' {
|
||||
function opn(target: string, callback?: (err: Error) => void): void;
|
||||
function opn(target: string, app: string, callback?: (err: Error) => void): void;
|
||||
export = opn;
|
||||
/// <reference path="../node/node.d.ts" />
|
||||
|
||||
declare namespace Opn {
|
||||
export interface Options {
|
||||
/**
|
||||
* Wait for the opened app to exit before calling the `callback`.
|
||||
* If `false` it's called immediately when opening the app.
|
||||
* On Windows you have to explicitly specify an app for it to be able to wait.
|
||||
*/
|
||||
wait?: boolean;
|
||||
|
||||
/**
|
||||
* Specify the app to open the target with, or an array with the app and app arguments.
|
||||
* The app name is platform dependent. Don't hard code it in reusable modules.
|
||||
* Eg. Chrome is `google chrome` on OS X, `google-chrome` on Linux and `chrome` on Windows.
|
||||
*/
|
||||
app?: string | string[];
|
||||
}
|
||||
}
|
||||
|
||||
declare module "opn" {
|
||||
import * as cp from "child_process";
|
||||
|
||||
interface DefaultFunction {
|
||||
/**
|
||||
* Uses the command open on OS X, start on Windows and xdg-open on other platforms.
|
||||
*
|
||||
* Returns the spawned child process.
|
||||
* You'd normally not need to use this for anything, but it can be useful if you'd like
|
||||
* to attach custom event listeners or perform other operations directly on the spawned process.
|
||||
*
|
||||
* @param target - The thing you want to open. Can be a URL, file, or executable. Opens in the default app for the file type. Eg. URLs opens in your default browser.
|
||||
*/
|
||||
(target: string): cp.ChildProcess;
|
||||
|
||||
/**
|
||||
* Uses the command open on OS X, start on Windows and xdg-open on other platforms.
|
||||
*
|
||||
* Returns the spawned child process.
|
||||
* You'd normally not need to use this for anything, but it can be useful if you'd like
|
||||
* to attach custom event listeners or perform other operations directly on the spawned process.
|
||||
*
|
||||
* @param target - The thing you want to open. Can be a URL, file, or executable. Opens in the default app for the file type. Eg. URLs opens in your default browser.
|
||||
* @param callback- Called when the opened app exits, or if `wait: false`, immediately when opening.
|
||||
*/
|
||||
(target: string, callback: (err: Error) => void): cp.ChildProcess;
|
||||
|
||||
/**
|
||||
* Uses the command open on OS X, start on Windows and xdg-open on other platforms.
|
||||
*
|
||||
* Returns the spawned child process.
|
||||
* You'd normally not need to use this for anything, but it can be useful if you'd like
|
||||
* to attach custom event listeners or perform other operations directly on the spawned process.
|
||||
*
|
||||
* @param target - The thing you want to open. Can be a URL, file, or executable. Opens in the default app for the file type. Eg. URLs opens in your default browser.
|
||||
* @param options - Options to be passed to opn.
|
||||
*/
|
||||
(target: string, options: Opn.Options): cp.ChildProcess;
|
||||
|
||||
/**
|
||||
* Uses the command open on OS X, start on Windows and xdg-open on other platforms.
|
||||
*
|
||||
* Returns the spawned child process.
|
||||
* You'd normally not need to use this for anything, but it can be useful if you'd like
|
||||
* to attach custom event listeners or perform other operations directly on the spawned process.
|
||||
*
|
||||
* @param target - The thing you want to open. Can be a URL, file, or executable. Opens in the default app for the file type. Eg. URLs opens in your default browser.
|
||||
* @param options - Options to be passed to opn.
|
||||
* @param callback- Called when the opened app exits, or if `wait: false`, immediately when opening.
|
||||
*/
|
||||
(target: string, options: Opn.Options, callback: (err: Error) => void): cp.ChildProcess;
|
||||
}
|
||||
|
||||
const opn: DefaultFunction;
|
||||
export = opn;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user