Skip to content

Commit c50084d

Browse files
committed
chore: Move types as they were before
1 parent df8e1d9 commit c50084d

File tree

6 files changed

+281
-280
lines changed

6 files changed

+281
-280
lines changed

js/helper.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,8 @@ function getPath() {
288288
* exits with a non-zero exit code.
289289
* @param {boolean} silent Disable stdout for silents build (CI/Webpack Stats, ...)
290290
* @param {string} [configFile] Relative or absolute path to the configuration file.
291-
* @param {Object} [config] More configuration to pass to the CLI
292-
* @returns {Promise.<string>} A promise that resolves to the standard output.
291+
* @param {import('./index').SentryCliOptions} [config] More configuration to pass to the CLI
292+
* @returns {Promise<string>} A promise that resolves to the standard output.
293293
*/
294294
async function execute(args, live, silent, configFile, config = {}) {
295295
const env = { ...process.env };

js/index.d.ts

Lines changed: 0 additions & 248 deletions
This file was deleted.

js/index.js

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ const pkgInfo = require('../package.json');
44
const helper = require('./helper');
55
const Releases = require('./releases');
66

7+
/**
8+
* @typedef {import('./types').SentryCliOptions} SentryCliOptions
9+
* @typedef {import('./types').SentryCliUploadSourceMapsOptions} SentryCliUploadSourceMapsOptions
10+
* @typedef {import('./types').SourceMapsPathDescriptor} SourceMapsPathDescriptor
11+
* @typedef {import('./types').SentryCliNewDeployOptions} SentryCliNewDeployOptions
12+
* @typedef {import('./types').SentryCliCommitsOptions} SentryCliCommitsOptions
13+
* @typedef {import('./types').SentryCliReleases} SentryCliReleases
14+
*/
15+
716
/**
817
* Interface to and wrapper around the `sentry-cli` executable.
918
*
@@ -27,8 +36,10 @@ class SentryCli {
2736
* location and the value specified in the `SENTRY_PROPERTIES` environment variable is
2837
* overridden.
2938
*
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
3243
*/
3344
constructor(configFile, options) {
3445
if (typeof configFile === 'string') {
@@ -62,7 +73,7 @@ class SentryCli {
6273
* - `false` to not inherit stdio and return the output as a string.
6374
* - `'rejectOnError'` to inherit stdio and reject the promise if the command
6475
* 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.
6677
*/
6778
execute(args, live) {
6879
return helper.execute(args, live, this.options.silent, this.configFile, this.options);

0 commit comments

Comments
 (0)