Skip to content

Commit

Permalink
change "memberOf" to "memberof" in jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
icebob committed Feb 27, 2018
1 parent 8650ad2 commit 1eddc3f
Show file tree
Hide file tree
Showing 26 changed files with 183 additions and 183 deletions.
10 changes: 5 additions & 5 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ declare namespace Moleculer {
* @param {any} opts options of call (optional)
* @returns
*
* @memberOf ServiceBroker
* @memberof ServiceBroker
*/
call<T, P extends GenericObject>(actionName: string, params?: P, opts?: CallOptions): Bluebird<T>;

Expand Down Expand Up @@ -343,7 +343,7 @@ declare namespace Moleculer {
* ```
* @throws MoleculerError - If the `def` is not an `Array` and not an `Object`.
*
* @memberOf ServiceBroker
* @memberof ServiceBroker
*/
mcall<T>(def: Array<CallDefinition> | { [name: string]: CallDefinition }): Bluebird<Array<T> | T>;

Expand All @@ -354,7 +354,7 @@ declare namespace Moleculer {
* @param {any} payload
* @returns
*
* @memberOf ServiceBroker
* @memberof ServiceBroker
*/
emit(eventName: string, payload?: any, groups?: string | Array<string>): void;

Expand All @@ -366,7 +366,7 @@ declare namespace Moleculer {
* @param {Array<string>?} groups
* @returns
*
* @memberOf ServiceBroker
* @memberof ServiceBroker
*/
broadcast(eventName: string, payload?: any, groups?: string | Array<string>): void

Expand All @@ -378,7 +378,7 @@ declare namespace Moleculer {
* @param {Array<string>?} groups
* @returns
*
* @memberOf ServiceBroker
* @memberof ServiceBroker
*/
broadcastLocal(eventName: string, payload?: any, groups?: string | Array<string>): void;

Expand Down
16 changes: 8 additions & 8 deletions src/cachers/base.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class Cacher {
*
* @param {object} opts
*
* @memberOf Cacher
* @memberof Cacher
*/
constructor(opts) {
this.opts = _.defaultsDeep(opts, {
Expand All @@ -35,7 +35,7 @@ class Cacher {
*
* @param {any} broker
*
* @memberOf Cacher
* @memberof Cacher
*/
init(broker) {
this.broker = broker;
Expand All @@ -54,7 +54,7 @@ class Cacher {
/**
* Close cacher
*
* @memberOf Cacher
* @memberof Cacher
*/
close() {
/* istanbul ignore next */
Expand All @@ -66,7 +66,7 @@ class Cacher {
*
* @param {any} key
*
* @memberOf Cacher
* @memberof Cacher
*/
get(/*key*/) {
/* istanbul ignore next */
Expand All @@ -80,7 +80,7 @@ class Cacher {
* @param {any} data
* @param {Number?} ttl
*
* @memberOf Cacher
* @memberof Cacher
*/
set(/*key, data, ttl*/) {
/* istanbul ignore next */
Expand All @@ -92,7 +92,7 @@ class Cacher {
*
* @param {any} key
*
* @memberOf Cacher
* @memberof Cacher
*/
del(/*key*/) {
/* istanbul ignore next */
Expand All @@ -105,7 +105,7 @@ class Cacher {
* @param {any} match string. Default is "**"
* @returns {Promise}
*
* @memberOf Cacher
* @memberof Cacher
*/
clean(/*match = "**"*/) {
/* istanbul ignore next */
Expand Down Expand Up @@ -183,7 +183,7 @@ class Cacher {
/**
* Register cacher as a middleware
*
* @memberOf Cacher
* @memberof Cacher
*/
middleware() {
return (handler, action) => {
Expand Down
14 changes: 7 additions & 7 deletions src/cachers/memory.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class MemoryCacher extends BaseCacher {
*
* @param {object} opts
*
* @memberOf MemoryCacher
* @memberof MemoryCacher
*/
constructor(opts) {
super(opts);
Expand All @@ -43,7 +43,7 @@ class MemoryCacher extends BaseCacher {
*
* @param {any} broker
*
* @memberOf Cacher
* @memberof Cacher
*/
init(broker) {
super.init(broker);
Expand All @@ -60,7 +60,7 @@ class MemoryCacher extends BaseCacher {
* @param {any} key
* @returns {Promise}
*
* @memberOf MemoryCacher
* @memberof MemoryCacher
*/
get(key) {
this.logger.debug(`GET ${key}`);
Expand All @@ -87,7 +87,7 @@ class MemoryCacher extends BaseCacher {
* @param {Number} ttl Optional Time-to-Live
* @returns {Promise}
*
* @memberOf MemoryCacher
* @memberof MemoryCacher
*/
set(key, data, ttl) {
if (ttl == null)
Expand All @@ -107,7 +107,7 @@ class MemoryCacher extends BaseCacher {
* @param {any} key
* @returns {Promise}
*
* @memberOf MemoryCacher
* @memberof MemoryCacher
*/
del(key) {
this.cache.delete(key);
Expand All @@ -120,7 +120,7 @@ class MemoryCacher extends BaseCacher {
* @param {any} match string. Default is "**"
* @returns {Promise}
*
* @memberOf Cacher
* @memberof Cacher
*/
clean(match = "**") {
this.logger.debug(`CLEAN ${match}`);
Expand All @@ -138,7 +138,7 @@ class MemoryCacher extends BaseCacher {
/**
* Check & remove the expired cache items
*
* @memberOf MemoryCacher
* @memberof MemoryCacher
*/
checkTTL() {
let now = Date.now();
Expand Down
14 changes: 7 additions & 7 deletions src/cachers/redis.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class RedisCacher extends BaseCacher {
*
* @param {object} opts
*
* @memberOf RedisCacher
* @memberof RedisCacher
*/
constructor(opts) {
if (typeof opts == "string")
Expand All @@ -35,7 +35,7 @@ class RedisCacher extends BaseCacher {
*
* @param {any} broker
*
* @memberOf RedisCacher
* @memberof RedisCacher
*/
init(broker) {
super.init(broker);
Expand Down Expand Up @@ -75,7 +75,7 @@ class RedisCacher extends BaseCacher {
/**
* Close Redis client connection
*
* @memberOf RedisCacher
* @memberof RedisCacher
*/
close() {
return this.client.quit();
Expand All @@ -87,7 +87,7 @@ class RedisCacher extends BaseCacher {
* @param {any} key
* @returns {Promise}
*
* @memberOf Cacher
* @memberof Cacher
*/
get(key) {
this.logger.debug(`GET ${key}`);
Expand All @@ -112,7 +112,7 @@ class RedisCacher extends BaseCacher {
* @param {Number} ttl Optional Time-to-Live
* @returns {Promise}
*
* @memberOf Cacher
* @memberof Cacher
*/
set(key, data, ttl) {
data = JSON.stringify(data);
Expand All @@ -134,7 +134,7 @@ class RedisCacher extends BaseCacher {
* @param {any} key
* @returns {Promise}
*
* @memberOf Cacher
* @memberof Cacher
*/
del(key) {
this.logger.debug(`DELETE ${key}`);
Expand All @@ -152,7 +152,7 @@ class RedisCacher extends BaseCacher {
* @param {any} match Match string for SCAN. Default is "*"
* @returns {Promise}
*
* @memberOf Cacher
* @memberof Cacher
*/
clean(match = "*") {
return new Promise((resolve, reject) => {
Expand Down
16 changes: 8 additions & 8 deletions src/context.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class Context {
* @example
* let ctx2 = new Context(broker, action);
*
* @memberOf Context
* @memberof Context
*/
constructor(broker, action) {
this.id = null;
Expand Down Expand Up @@ -150,7 +150,7 @@ class Context {
* @param {Object} newParams
* @param {Boolean} cloning
*
* @memberOf Context
* @memberof Context
*/
setParams(newParams, cloning = false) {
if (cloning && newParams)
Expand All @@ -165,7 +165,7 @@ class Context {
* @param {Object} newMeta
*
* @private
* @memberOf Context
* @memberof Context
*/
_mergeMeta(newMeta) {
if (newMeta)
Expand All @@ -184,7 +184,7 @@ class Context {
* @example <caption>Call an other service with params & options</caption>
* ctx.call("posts.get", { id: 12 }, { timeout: 1000 });
*
* @memberOf Context
* @memberof Context
*/
call(actionName, params, opts = {}) {
opts.parentCtx = this;
Expand Down Expand Up @@ -231,7 +231,7 @@ class Context {
* @example
* ctx.emit("user.created", { entity: user, creator: ctx.meta.user });
*
* @memberOf Context
* @memberof Context
*/
emit(eventName, data, groups) {
return this.broker.emit(eventName, data, groups);
Expand All @@ -248,7 +248,7 @@ class Context {
* @example
* ctx.broadcast("user.created", { entity: user, creator: ctx.meta.user });
*
* @memberOf Context
* @memberof Context
*/
broadcast(eventName, data, groups) {
return this.broker.broadcast(eventName, data, groups);
Expand All @@ -260,7 +260,7 @@ class Context {
* @param {boolean} emitEvent
*
* @private
* @memberOf Context
* @memberof Context
*/
_metricStart(emitEvent) {
this.startTime = Date.now();
Expand Down Expand Up @@ -302,7 +302,7 @@ class Context {
* @param {boolean} emitEvent
*
* @private
* @memberOf Context
* @memberof Context
*/
_metricFinish(error, emitEvent) {
if (this.startHrTime) {
Expand Down
Loading

0 comments on commit 1eddc3f

Please sign in to comment.