Skip to content

add typings #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PerseusPotter wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add typings #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
049b567
typings
May 17, 2025
9d6d95b
forgot tree man is bad
May 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 51 additions & 36 deletions storage/LocalStore.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,66 @@
const cachedInstances = []

const moduleNameSym = Symbol("moduleName")
const fileNameSym = Symbol("fileName")

/**
* - This data is meant to be edited on the fly as well as gathered from a file
* - Note: The data is backed up in a folder inside of `.minecraft/config/tska-backup` every 10minutes
* and whenever the file gets corrupted it attempts to re-set it with the backup one
* @template T
* @param {string} moduleName
* @param {T} [defaultData={}] `{}`
* @param {string} [fileName=".data.json"] `".data.json"`
* @returns {T & LocalStoreImpl<T>}
*/
export class LocalStore {
constructor(moduleName, defaultData = {}, fileName = ".data.json") {
let cachedData = FileLib.read(moduleName, fileName) || FileLib.read(`./config/tska-backup/${moduleName}/${fileName}`)
if (!cachedData && FileLib.exists(moduleName, fileName))
console.warn(`[TSKA] Seems like your data for module \"${moduleName}\" was corruputed therefore resetted.`)

const parsed = JSON.parse(cachedData || "{}")
Object.assign(this, defaultData, parsed)

/**
* - Function that returns the module's `moduleName` and `fileName`
* to store the data at
* @private
* @returns {[string, string]}
*/
this.getModuleData = () => {
return [ moduleName, fileName ]
}

cachedInstances.push(this)
}
function LocalStoreImpl(moduleName, defaultData = {}, fileName = ".data.json") {
if (!(this instanceof LocalStoreImpl)) return new LocalStoreImpl(moduleName, defaultData, fileName)

/**
* - This function is mostly for internal use since the dev should not handle this
* but it is open to use if you feel like it is better.
* - This gets called every time the game unloads automatically
* @deprecated
*/
save() {
const [ moduleName, fileName ] = this.getModuleData()
let cachedData = FileLib.read(moduleName, fileName) || FileLib.read(`./config/tska-backup/${moduleName}/${fileName}`)
if (!cachedData && FileLib.exists(moduleName, fileName))
console.warn(`[TSKA] Seems like your data for module \"${moduleName}\" was corruputed therefore resetted.`)

FileLib.write(moduleName, fileName, JSON.stringify(this, null, 4), true)
}
const parsed = JSON.parse(cachedData || "{}")
Object.assign(this, defaultData, parsed)

/** @private */
_saveBackup() {
const [ moduleName, fileName ] = this.getModuleData()
this[moduleNameSym] = moduleName
this[fileNameSym] = fileName

FileLib.write(`./config/tska-backup/${moduleName}/${fileName}`, JSON.stringify(this, null, 4), true)
}
cachedInstances.push(this)

return this
}

/**
* - Function that returns the module's `moduleName` and `fileName`
* to store the data at
* @private
* @returns {[string, string]}
*/
LocalStoreImpl.prototype.getModuleData = () => {
return [this[moduleNameSym], this[fileNameSym]]
}
/**
* - This function is mostly for internal use since the dev should not handle this
* but it is open to use if you feel like it is better.
* - This gets called every time the game unloads automatically
* @deprecated
*/
LocalStoreImpl.prototype.save = function save() {
const [moduleName, fileName] = this.getModuleData()

FileLib.write(moduleName, fileName, JSON.stringify(this, null, 4), true)
}

/** @private */
LocalStoreImpl.prototype._saveBackup = function _saveBackup() {
const [moduleName, fileName] = this.getModuleData()

FileLib.write(`./config/tska-backup/${moduleName}/${fileName}`, JSON.stringify(this, null, 4), true)
}

/** @type {{ new<T>(moduleName: string, defaultData: T, fileName: string): (T & LocalStoreImpl<T>) } & typeof LocalStoreImpl} */
export const LocalStore = LocalStoreImpl

const data = new LocalStore("tska", {
LocalStore: {
Expand Down