@skyrim-platform/jcontainers
Version:
TypeScript library for the JContainers Skyrim modding utility
19 lines (18 loc) • 1.08 kB
TypeScript
/** It's NOT part of public API */
export declare const __isInstalled: () => boolean;
/** Version information.
It's a good practice to validate installed JContainers version with the following code:
bool isJCValid = JContainers.APIVersion() == AV && JContainers.featureVersion() >= FV
where AV and FV are hardcoded API and feature version numbers.
Current API version is 4
Current feature version is 2 */
export declare const APIVersion: () => number;
export declare const featureVersion: () => number;
/** Returns true if the file at a specified @path exists */
export declare const fileExistsAtPath: (path: string) => boolean;
export declare const contentsOfDirectoryAtPath: (directoryPath: string, extension?: string) => string[];
/** Deletes the file or directory identified by the @path */
export declare const removeFileAtPath: (path: string) => void;
/** A path to user-specific directory - My Games/Skyrim Special Edition/JCUser/ */
export declare const userDirectory: () => string;
export declare const isInstalled: () => boolean;