vladimiry / fs-no-eperm-anymore Goto Github PK

Like specifying custom parameters for the specific functions and error codes, following the inheritance ideas. So options might look like this:

const options = {
    platform: "win32", // optional
    retryIntervalMs: 50,
    retryTimeoutMs: 30 * 1000,
    retryCountLimit: 123, // optional
    errorCodes: ["EPERM"],
    errorCodesMap: {  // optional
        EACCS: {
            retryIntervalMs: 500, // optional
            retryTimeoutMs: 10 * 1000, // optional
            retryCountLimit: 345, // optional
        },
    },
    functionsMap: { // optional
        rename: {
            platform: "linux", // optional
            retryIntervalMs: 50, // optional
            retryTimeoutMs: 30 * 1000, // optional
            retryCountLimit: 45746,  // optional
            errorCodesMap: {  // optional
                EPERM: {
                    retryIntervalMs: 5454,  // optional
                    retryTimeoutMs: 123 * 1000,  // optional
                    retryCountLimit: 662,  // optional
                },
                EEXIST: {
                    retryIntervalMs: 1500,  // optional
                    retryTimeoutMs: 5 * 1000,  // optional
                    retryCountLimit: 345,  // optional
                },
            },
        },
    },
};

Where:

• platform and retryCountLimit are always optional. If the are no values specified, then retry executes for any platform and number of retry attempts is not limited by the retryCountLimit value (only by the retryIntervalMs and retryTimeoutMs).
• retryIntervalMs and retryTimeoutMs are optional on any level except the top level. Means if there is no custom values defined on the errorCodesMap / functionsMap levels/sub-levels, then default values defined on the top level take place.
• errorCodes basically can be an empty array, then no error handling happens - any happened error re-throws (goes up).
• platform can be specified on either top or Options.functionsMap[<function name>] levels.

So retryIntervalMs, retryTimeoutMs, retryTimeoutMs resolving occurs in the inherited way (from the most narrow object, up to the wider/global object):

1. Options.functionsMap[<function name>].errorCodes[<error code>]
2. Options.functionsMap[<function name>]
3. Options.errorCodesMap[<error code>]
4. Options (top level).