@seneca/srv-admin v0.0.1

@seneca/srv-admin

Documentation helper for Seneca plugins.

Install

$ npm install @seneca/srv-admin -D

seneca.use('srv-admin')

Action Patterns

• get:service,role:admin
• hook:register,role:admin
• list:service,role:admin

Action Descriptions

« get:service,role:admin »

Get service description.

Examples

• get:service,role:admin,name:foo
  • Describe service foo.

Parameters

• name: string {presence:required}
  • The name of the service.

Replies With

{
  package: 'Service package'
}

« hook:register,role:admin »

Register a service description. Typically used during the plugin init phase.

Examples

• hook:register,role:admin,service:{package:<package>}
  • Provide service description.

Parameters

• service: object {presence:required}
  • Service description object.

« list:service,role:admin »

List registered services.

Replies With

{
  items: 'Array of service descriptions.'
}