Adapt authoring tool UI documentation

v1.0.0-rc.4

adapt-authoring-mongodb/lib/typedefs.js

  1. /**
  2. * This file exists to define the below types for documentation purposes.
  3. */
  4. /**
  5. * MongoDB collection
  6. * @memberof mongodb
  7. * @external MongoDBCollection
  8. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/api/classes/Collection.html}
  9. */
  10. /**
  11. * Options passed to the createIndex function
  12. * @memberof mongodb
  13. * @external MongoDBCreateIndexesOptions
  14. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/CreateIndexesOptions.html}
  15. */
  16. /**
  17. * Options passed to the delete functions
  18. * @memberof mongodb
  19. * @external MongoDBDeleteOptions
  20. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/DeleteOptions.html}
  21. */
  22. /**
  23. * Options passed to the findOneAndReplace function
  24. * @memberof mongodb
  25. * @external MongoDBFindOneAndReplaceOptions
  26. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/FindOneAndReplaceOptions.html}
  27. */
  28. /**
  29. * Options passed to the findOneAndUpdate function
  30. * @memberof mongodb
  31. * @external MongoDBFindOneAndUpdateOptions
  32. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/FindOneAndUpdateOptions.html}
  33. */
  34. /**
  35. * Options passed to the find function
  36. * @memberof mongodb
  37. * @external MongoDBFindOptions
  38. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/FindOptions.html}
  39. */
  40. /**
  41. * Options passed to the insertOne function
  42. * @memberof mongodb
  43. * @external MongoDBInsertOneOptions
  44. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/interfaces/InsertOneOptions.html}
  45. */
  46. /**
  47. * MongoDB client for DB connections
  48. * @memberof mongodb
  49. * @external MongoDBMongoClient
  50. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/api/MongoClient.html}
  51. */
  52. /**
  53. * MongoDB representation of BSON ObjectId type
  54. * @memberof mongodb
  55. * @external MongoDBObjectId
  56. * @see {@link https://mongodb.github.io/node-mongodb-native/4.2/api/ObjectID.html}
  57. */