aws-crt/lib/native/error.ts

NodeJS/browser bindings to the aws-c-* libraries

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

/**
 * Library-specific error extension type
 *
 * @packageDocumentation
 * @module error
 * @mergeTarget
 */

import crt_native from './binding';
import {ICrtError} from "../common/error";

export {ICrtError} from "../common/error";

/**
 * Represents an error encountered in native code. Can also be used to convert a numeric error code into
 * a human-readable string.
 *
 * @category System
 */
export class CrtError extends Error implements ICrtError {
    /** The original integer error code from the CRT */
    readonly error_code?: number;
    /** The translated error name (e.g. AWS_ERROR_UNKNOWN) */
    readonly error_name?: string;

    /** @var error - The original error. Most often an error_code, but possibly some other context */
    constructor(readonly error: any) {
        super(extract_message(error));
        this.error_code = extract_code(error);
        this.error_name = extract_name(error);
    }
}

function extract_message(error: any): string {
    if (typeof error === 'number') {
        return crt_native.error_code_to_string(error);
    } else if (error instanceof CrtError) {
        return error.message;
    }
    return error.toString();
}

function extract_code(error: any) {
    if (typeof error === 'number') {
        return error;
    } else if (error instanceof CrtError) {
        return error.error_code;
    }
    return undefined;
}

function extract_name(error: any) {
    if (typeof error === 'number') {
        return crt_native.error_code_to_name(error);
    } else if (error instanceof CrtError) {
        return error.error_name;
    }
    return undefined;
}