@axway/api-builder-config

A singleton module for loading custom configurations

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@axway/api-builder-config
Minified + gzip package size for @axway/api-builder-config in KB

Readme

@axway/api-builder-config

A singleton module for loading custom configurations

API Reference

api-builder-config.ApiBuilderConfig

A config manager.

Kind: instance class of api-builder-config

new ApiBuilderConfig()

Constructs a config manager. The instance is a singleton.

apiBuilderConfig.setFlagDisabledHandler(handler)

Sets a callback handler to use when a deprecation is identified.

Kind: instance method of ApiBuilderConfig

Param Type Description
handler func A callback handler that will accept the flag as { id, isBreaking, default, message, prop }

apiBuilderConfig.clear() ⇒ ApiBuilderConfig

Clears all flags and resets state. All registered flags will be automatically re-added on next load.

Kind: instance method of ApiBuilderConfig
Returns: ApiBuilderConfig - The ApiBuilderConfig object.
Accessible: through the instance

Building

npm run build

Author

Axway support@axway.com https://axway.com

License

This code is proprietary, closed source software licensed to you by Axway. All Rights Reserved. You may not modify Axway’s code without express written permission of Axway. You are licensed to use and distribute your services developed with the use of this software and dependencies, including distributing reasonable and appropriate portions of the Axway code and dependencies. Except as set forth above, this code MUST not be copied or otherwise redistributed without express written permission of Axway. This module is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement (General Conditions) located here: https://support.axway.com/en/auth/general-conditions; EXCEPT THAT IF YOU RECEIVED A FREE SUBSCRIPTION, LICENSE, OR SUPPORT SUBSCRIPTION FOR THIS CODE, NOTWITHSTANDING THE LANGUAGE OF THE GENERAL CONDITIONS, AXWAY HEREBY DISCLAIMS ALL SUPPORT AND MAINTENANCE OBLIGATIONS, AS WELL AS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED INFRINGEMENT WARRANTIES, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND YOU ACCEPT THE PRODUCT AS-IS AND WITH ALL FAULTS, SOLELY AT YOUR OWN RISK. Your right to use this software is strictly limited to the term (if any) of the license or subscription originally granted to you.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.