mafiles/build/index.d.ts

Parser for Steam Desktop Authenticator's (SDA) maFiles.

import { MaFile, Options } from "./types/sda";
/**
 * Attempts to read and parse a specified maFile. Supports decryption of the maFiles.
 * If the maFile is encrypted and the password option isn't set, then the user will be prompted for the encryption password
 * via STDIN.
 *
 * @param {string} manifestPath Path to the SDA manifest.json file containing more information about the maFiles.
 * @param {(string|BigInt)} steamid64 steamid64 of the steam account that we want the maFile of.
 * @param options All optional.
 * @param {string} options.password The password that was used for encrypting the SDA. Define this for an instant decryption.
 * @param {string} options.maFilePath This allows you to directly specify where the targeted maFile is located.
 * @returns Either the JSON parsed maFile in case of a success or `null` in case of an error.
 * @example
 * const maFile = await mafiles("./SDA/manifest.json", "76561197960287930", {
 *     password: "3ncrypt10n_Passw0rd",
 *     maFilePath: "./SDA/maFiles/account.maFile"
 * })
 */
export default function mafiles(manifestPath: string, steamid64: string | BigInt, options?: Options | null): Promise<MaFile | null>;
export { MaFile } from "./types/sda";