@seneca/srv-admin

    0.0.1 • Public • Published

    @seneca/srv-admin

    Npm Travis Coveralls

    Documentation helper for Seneca plugins.

    Install

    $ npm install @seneca/srv-admin -D
    seneca.use('srv-admin')

    Action Patterns

    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.'
    }
    

    Install

    npm i @seneca/srv-admin

    DownloadsWeekly Downloads

    8

    Version

    0.0.1

    License

    MIT

    Unpacked Size

    73.8 kB

    Total Files

    10

    Last publish

    Collaborators

    • stokesriona
    • seneca-owner
    • rjrodger