@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
34 lines • 1.31 kB
TypeScript
import { FeatureInterface } from '../../api/cloud/FeatureApi';
import { State } from '../../shared/State';
export type Feature = {
/**
* Read all features
* @returns {Promise<FeatureInterface[]>} a promise that resolves to an array of feature objects
*/
readFeatures(): Promise<FeatureInterface[]>;
/**
* Check if feature is available
* @param {string} featureId feature id (e.g. 'service-accounts')
* @returns {Promise<boolean>} a promise that resolves to true if the feature is available and to false otherwise
*/
hasFeature(featureId: string): Promise<boolean>;
};
declare const _default: (state: State) => Feature;
export default _default;
/**
* Read all features
* @returns {Promise<FeatureInterface[]>} a promise that resolves to an array of feature objects
*/
export declare function readFeatures({ state, }: {
state: State;
}): Promise<FeatureInterface[]>;
/**
* Check if feature is available
* @param {string} featureId feature id (e.g. 'service-accounts')
* @returns {Promise<boolean>} a promise that resolves to true if the feature is available and to false otherwise
*/
export declare function hasFeature({ featureId, state, }: {
featureId: string;
state: State;
}): Promise<boolean>;
//# sourceMappingURL=FeatureOps.d.ts.map