You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Interface to and wrapper around the `sentry-cli` executable.
9
18
*
@@ -27,8 +36,10 @@ class SentryCli {
27
36
* location and the value specified in the `SENTRY_PROPERTIES` environment variable is
28
37
* overridden.
29
38
*
30
-
* @param {string} [configFile] Relative or absolute path to the configuration file.
31
-
* @param {Object} [options] More options to pass to the CLI
39
+
* @param {string | null} [configFile] - Path to Sentry CLI config properties, as described in https://docs.sentry.io/learn/cli/configuration/#properties-files.
40
+
* By default, the config file is looked for upwards from the current path and defaults from ~/.sentryclirc are always loaded.
41
+
* This value will update `SENTRY_PROPERTIES` env variable.
42
+
* @param {SentryCliOptions} [options] - More options to pass to the CLI
32
43
*/
33
44
constructor(configFile,options){
34
45
if(typeofconfigFile==='string'){
@@ -62,7 +73,7 @@ class SentryCli {
62
73
* - `false` to not inherit stdio and return the output as a string.
63
74
* - `'rejectOnError'` to inherit stdio and reject the promise if the command
64
75
* exits with a non-zero exit code.
65
-
* @returns {Promise.<string>} A promise that resolves to the standard output.
76
+
* @returns {Promise<string>} A promise that resolves to the standard output.
0 commit comments