Skip to content

Commit

Permalink
docs(files): improve jsdoc for new features
Browse files Browse the repository at this point in the history
  • Loading branch information
josephmcg committed Apr 28, 2022
1 parent 80b5b1e commit d82722e
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
6 changes: 6 additions & 0 deletions components/views/files/aside/Aside.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,15 @@ export default Vue.extend({
}
},
computed: {
/**
* @description total size of all uploaded files
*/
totalSize(): string {
return this.$filesize(this.$FileSystem.totalSize)
},
/**
* @description storage space (free tier is 4GB)
*/
sizeLimit(): string {
return this.$filesize(this.$Config.personalFilesLimit)
},
Expand Down
11 changes: 11 additions & 0 deletions components/views/files/aside/List/List.vue
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,25 @@ export default Vue.extend({
},
},
methods: {
/**
* @method setActive
* @description set files page route (default, recent, deleted, etc...)
* @param {FileAsideRouteEnum} route clicked route string value
*/
setActive(route: FileAsideRouteEnum) {
if (!route) {
this.$router.push({ query: {} })
return
}
this.$router.push({ query: { route } })
},
/**
* @method isActiveRoute
* @description used to set active css class on list
* @param {FileAsideRouteEnum} route clicked route string value
*/
isActiveRoute(route: FileAsideRouteEnum) {
// if default route
if (!this.$route.query.route && !route) {
return true
}
Expand Down
13 changes: 7 additions & 6 deletions libraries/Files/FilSystem.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,18 +98,18 @@ export class FilSystem {
}

/**
* @getter flatFiles
* @getter flat
* @returns {Fil[]} flattened list of files
*/
get flat(): Fil[] {
return this._flatDeepByKey(this._self.content, 'content').filter(
return this._flatDeepByKey(this.root.content, 'content').filter(
(item: Item) => item instanceof Fil,
)
}

/**
* @getter flatFiles
* @returns {Fil[]} flattened list of most recent 15 files
* @getter recentFiles
* @returns {Fil[]} most recent 15 files, sorted by modified date
*/
get recentFiles(): Fil[] {
return this.flat
Expand All @@ -119,8 +119,9 @@ export class FilSystem {

/**
* @method _flatDeepByKey
* @description recursively converts item to the proper format for export
* @param {}
* @description recursively flattens all directories
* @param {Item[]} data current directory items (starting with root, then calls itself when a child dir is found)
* @param {keyof Directory} key in this case, 'content' getter
* @returns {Item[]} flattened list of files and directories
*/
private _flatDeepByKey(data: Item[], key: keyof Directory) {
Expand Down
1 change: 1 addition & 0 deletions pages/files/browse/index.vue
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ export default Vue.extend({
'$route.query.route': {
handler(value) {
this.fileSystem.goBackToDirectory('root')
// if invalid route, reset to default
if (!Object.values(FileAsideRouteEnum).includes(value)) {
this.$router.push({ query: {} })
}
Expand Down

0 comments on commit d82722e

Please sign in to comment.