Module internal`Internal`

Utilities typically only used internally, but occasionally useful for users, so they are made available here.

0.1.0-alpha

import { internal } from '@maddimathon/build-utilities';
import { ... } from '@maddimathon/build-utilities/internal';

Config

getPackageJson: Gets a copy of the package.json object for the current npm project.
internalConfig: Takes a partial Config object and converts it to a Config.Internal object.
isConfigValid: Tests whether the provided object includes all properties required from a valid Config object.
SemVer: For parsing and validating semantic version strings.
SemVer: Used only for the SemVer class.

errorHandler: Default error handler for use within the library.
errorStringify: Returns a string(s) representation of an error for logging.
logError: Writes the content of an error to a log file and outputs (to the console) a confirmation message with the path to the log file.
writeLog: Writes a log file to the Config.Paths.scripts.logs directory.
AbstractError: An extension of the utilities error for use within the library.
ProjectError: An extension of the utilities error for use while running a Project.
StageError: An extension of the utilities error for use while running a Project.
UnknownCaughtError: An extension of the utilities error for caught errors, mainly ones that are not (Error) objects already.
logError: Utilities used only for logError function.
writeLog: Utilities used only for writeLog function.

FileSystemType: Shape of the file/path utility class.
Logger: Shape of a logging utility class to be available within the library.
AbstractError: Types used for AbstractError classes.
FileSystemType: Types for the FileSystemType interface.
Logger: Type utilities for Logger classes.

isObjectEmpty: Checks whether an object is empty (by checking for keys and constructor).