Error IO tag for Imperative Errors
The yamljs package requires you to indicate the depth for conversion to yaml. Set to max of 9999.
Creates the full set of directories indicated by the path. Used to create the profile root directory and type directories.
The directory path to create - creates all necessary subdirectories.
Delete the profile and ensure it is gone.
the profile object - really only used for error messages
the full file path to delete
Checks if the file specified exists.
The file path
Extracts the profile name from the file path/name
the file path to extract the profile name
the extension of the file
Accepts the profiles root directory and returns all directories within. The directories within the root directory are all assumed to be profile type directories (potentially containing a meta file and profiles of that type).
The profiles root directory to obtain all profiles from.
Accepts the profile directory location for a type, reads all filenames, and returns a list of profile names that are present within the directory (excluding the meta profile)
The directory for the type
the extension for the profile files (normally YAML)
the meta name for this type
Read the profile meta file using Yaml "safeLoad" (ensures that no code executes, etc. during the load). The meta profile file for a type contains the default profile specification. The meta profile is ALWAYS in YAML format (controlled exclusively by the Imperative framework).
The path to the meta profile
Read a profile from disk. Profiles are always assumed to be YAML (YAML "safeLoad" is invoked to perform the load).
Path to the profile.
The profile type; used to populate the "type" in the profile object (type property not persisted on disk).
Converts the meta to yaml and writes to disk
The meta profile contents to write to disk
The path to the meta profile
Accepts a profile object and writes the profile to the specified location (and optionally converts the profile to YAML format - the default for Imperative profiles).
the fully qualified profile path, file, & extension.
the profile object to write to disk.
Generated using TypeDoc
Profile IO methods for writing/reading profiles to disk. The profile managers never invoke "fs" directly. All "fs" calls are wrapped here and errors are transformed to ImperativeError for error handling/flow throughout Imperative.