Skip to content

Commit

Permalink
chore(docs): make sure all types are detected correctly
Browse files Browse the repository at this point in the history
  • Loading branch information
stfsy committed Apr 27, 2024
1 parent ff3a51b commit 4c457e8
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 28 deletions.
23 changes: 0 additions & 23 deletions lib/index.js
@@ -1,31 +1,8 @@
'use strict'

/**
* @typedef {import('./simple-resource-storage.js')} SimpleResourceStorage
*/
module.exports.SimpleResourceStorage = require('./simple-resource-storage.js')

/**
* @typedef {import('./one-to-few-ref-storage.js')} OneToFewRefStorage
*/
module.exports.OneToFewRefStorage = require('./one-to-few-ref-storage.js')

/**
* @typedef {import('./one-to-few-resource-storage.js')} OneToFewResourceStorage
*/
module.exports.OneToFewResourceStorage = require('./one-to-few-resource-storage.js')

/**
* @typedef {import('./one-to-many-resource-storage.js')} OneToManyResourceStorage
*/
module.exports.OneToManyResourceStorage = require('./one-to-many-resource-storage.js')

/**
* @typedef {import('./history.js')} ResourceStorageHistory
*/
module.exports.ResourceStorageHistory = require('./history.js')

/**
* @typedef {import('./locks.js')} ResourceLock
*/
module.exports.ResourceLock = require('./locks.js')
1 change: 0 additions & 1 deletion lib/one-to-few-resource-storage.js
Expand Up @@ -41,7 +41,6 @@ const { withActiveSpan } = createTracer({

/**
* @name GetOptions
* @private
* @typedef GetOptions
* @property {boolean} withMetadata true if also meta data should be returned
* @property {Object} projection MongoDB projection object e.g. { id: 0, name: 0 }
Expand Down
6 changes: 2 additions & 4 deletions lib/one-to-many-resource-storage.js
Expand Up @@ -49,7 +49,6 @@ const { withActiveSpan } = createTracer({

/**
* @name GetOptions
* @private
* @typedef GetOptions
* @property {boolean} withMetadata true if also meta data should be returned
* @property {boolean} addDocumentPath true if $path propety should be added to documents e.g. `$path=/countries/1/cities/2/companies`
Expand Down Expand Up @@ -102,9 +101,8 @@ const { withActiveSpan } = createTracer({
module.exports = class extends Base {

/**
*
* @public
* @param {ConstructorOptions} options
* @returns
*/
constructor(options) {
const baseOptions = Object.assign({}, options)
Expand Down Expand Up @@ -158,7 +156,7 @@ module.exports = class extends Base {
*
* @name get
* @param {String|Array.<String>} resourceIds resource ids that will added to the resource path i.e. /users/${id}/documents/${id}
* @param {GetOptions} options
* @param {Object} options
* @returns {Object}
*/
async get(resourceIds, options) {
Expand Down

0 comments on commit 4c457e8

Please sign in to comment.