Docs build: bf153cc

node-11.13.5.json

@@ -0,0 +1 @@
+{"meta":{"generator":"0.0.1","format":19},"custom":{"Getting Started":{"name":"Getting Started","files":{"GettingStarted":{"name":"Getting Started","type":"md","content":"placeholder","path":"guides/Getting Started/GettingStarted.md"}}}},"classes":[{"name":"KlasaMember","description":"Klasa's Extended GuildMember","extends":["external:GuildMember"],"construct":{"name":"KlasaMember","params":[{"name":"args","description":"Normal D.JS GuildMember args","variable":true,"type":[["*"]]}]},"props":[{"name":"settings","description":"The member level settings for this context (member || default)","type":[[["external:Settings"]]],"meta":{"line":26,"file":"KlasaMember.js","path":"src/lib/extensions"},"since":"0.0.1"}],"methods":[{"name":"toJSON","description":"Returns the JSON-compatible object of this instance.","returns":[[["KlasaMemberJSON"]]],"meta":{"line":34,"file":"KlasaMember.js","path":"src/lib/extensions"},"since":"0.5.0"}],"meta":{"line":8,"file":"KlasaMember.js","path":"src/lib/extensions"}},{"name":"MemberGateway","description":"The Gateway class that manages the data input, parsing, and output, of an entire database, while keeping a cache system sync with the changes.","extends":["GatewayStorage"],"construct":{"name":"MemberGateway","params":[{"name":"store","description":"The GatewayDriver instance which initiated this instance","type":[[["GatewayDriver"]]]},{"name":"type","description":"The name of this Gateway","type":[[["string"]]]},{"name":"schema","description":"The schema for this gateway","type":[[["external:Schema"]]]},{"name":"provider","description":"The provider's name for this gateway","type":[[["string"]]]}]},"props":[{"name":"store","description":"The GatewayDriver that manages this Gateway","type":[[["external:GatewayDriver"]]],"meta":{"line":25,"file":"MemberGateway.js","path":"src/lib/settings"},"since":"0.0.1"},{"name":"syncQueue","description":"The synchronization queue for all Settings instances","type":[[["external:Collection","<"],["string",", "],["Promise","<"],["external:Settings",">>"]]],"meta":{"line":32,"file":"MemberGateway.js","path":"src/lib/settings"},"since":"0.0.1"},{"name":"Settings","description":"The Settings that this class should make.","access":"private","readonly":true,"type":[[["external:Settings"]]],"meta":{"line":49,"file":"MemberGateway.js","path":"src/lib/settings"},"since":"0.0.1"},{"name":"idLength","description":"The ID length for all entries.","access":"private","readonly":true,"type":[[["number"]]],"meta":{"line":60,"file":"MemberGateway.js","path":"src/lib/settings"},"since":"0.0.1"}],"methods":[{"name":"get","description":"Get a Settings entry from this gateway","params":[{"name":"id","description":"The id for this instance","type":[[["string"]],[["Array","<"],["string",">"]]]}],"returns":{"types":[[["external:Settings"]]],"nullable":true},"meta":{"line":71,"file":"MemberGateway.js","path":"src/lib/settings"},"since":"0.0.1"},{"name":"create","description":"Create a new Settings for this gateway","params":[{"name":"id","description":"The id for this instance","type":[[["string"]],[["Array","<"],["string",">"]]]},{"name":"data","description":"The data for this Settings instance","optional":true,"default":"{}","type":[[["Object","<"],["string",", "],["*",">"]]]}],"returns":[[["external:Settings"]]],"meta":{"line":90,"file":"MemberGateway.js","path":"src/lib/settings"},"since":"0.0.1"},{"name":"sync","description":"Sync either all entries from the cache with the persistent database, or a single one.","params":[{"name":"input","description":"An object containing a id property, like discord.js objects, or a string","optional":true,"default":"Array<string>","type":[[["Array","<"],["string",">"]],[["string"]]]}],"returns":{"types":[[["Promise","<"],["MemberGateway",">"]],[["Promise","<"],["external:Settings",">"]]],"nullable":true},"async":true,"meta":{"line":106,"file":"MemberGateway.js","path":"src/lib/settings"},"since":"0.0.1"}],"meta":{"line":8,"file":"MemberGateway.js","path":"src/lib/settings"}}],"typedefs":[{"name":"KlasaMemberJSON","type":[[["external:GuildMemberJSON"]]],"props":[{"name":"settings","description":"The per member settings","type":[[["external:SettingsJSON"]]]}],"meta":{"line":10,"file":"KlasaMember.js","path":"src/lib/extensions"}}],"externals":[{"name":"GuildMember","see":["{@link https://discord.js.org/#/docs/main/master/class/GuildMember}"],"meta":{"line":10,"file":"index.js","path":"src"}},{"name":"Settings","see":["{@link https://klasa.js.org/#/docs/klasa/master/class/Settings}"],"meta":{"line":14,"file":"index.js","path":"src"}},{"name":"GatewayStorage","see":["{@link https://klasa.js.org/#/docs/klasa/master/class/GatewayStorage}"],"meta":{"line":18,"file":"index.js","path":"src"}},{"name":"GatewayDriver","see":["{@link https://klasa.js.org/#/docs/klasa/master/class/GatewayDriver}"],"meta":{"line":22,"file":"index.js","path":"src"}},{"name":"Schema","see":["{@link https://klasa.js.org/#/docs/klasa/master/class/Schema}"],"meta":{"line":26,"file":"index.js","path":"src"}},{"name":"Collection","see":["{@link https://discord.js.org/#/docs/main/master/class/Collection}"],"meta":{"line":30,"file":"index.js","path":"src"}},{"name":"GatewayGetPathOptions","see":["{@link https://klasa.js.org/#/docs/klasa/master/typedef/GatewayGetPathOptions}"],"meta":{"line":34,"file":"index.js","path":"src"}},{"name":"GatewayJSON","see":["{@link https://klasa.js.org/#/docs/klasa/master/typedef/GatewayJSON}"],"meta":{"line":38,"file":"index.js","path":"src"}},{"name":"SettingsJSON","see":["{@link https://klasa.js.org/#/docs/klasa/master/typedef/SettingsJSON}"],"meta":{"line":42,"file":"index.js","path":"src"}}]}