@salesforce/plugin-limits
Version:
commands to display api limits to your org
55 lines • 2.25 kB
JavaScript
/*
* Copyright 2025, Salesforce, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Messages, SfError } from '@salesforce/core';
import { SfCommand, orgApiVersionFlagWithDeprecations, loglevel, requiredOrgFlagWithDeprecations, } from '@salesforce/sf-plugins-core';
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@salesforce/plugin-limits', 'display');
export class LimitsApiDisplayCommand extends SfCommand {
static aliases = ['force:limits:api:display', 'limits:api:display'];
static deprecateAliases = true;
static summary = messages.getMessage('summary');
static description = messages.getMessage('description');
static examples = messages.getMessages('examples');
static flags = {
'target-org': requiredOrgFlagWithDeprecations,
'api-version': orgApiVersionFlagWithDeprecations,
loglevel,
};
async run() {
try {
const { flags } = await this.parse(LimitsApiDisplayCommand);
const conn = flags['target-org'].getConnection(flags['api-version']);
const result = await conn.request('/limits');
const limits = Object.entries(result).map(([name, { Max, Remaining }]) => ({
name,
max: Max,
remaining: Remaining,
}));
this.table({
data: limits,
columns: ['name', 'remaining', 'max'],
});
return limits;
}
catch (err) {
if (err instanceof Error || typeof err === 'string') {
throw SfError.wrap(err);
}
throw err;
}
}
}
//# sourceMappingURL=limits.js.map