@nats-io/services
    Preparing search index...

    Interface ServiceGroup

    interface ServiceGroup {
        addEndpoint(
            name: string,
            opts?: ServiceHandler | Partial<Endpoint>,
        ): QueuedIterator<ServiceMsg>;
        addGroup(subject?: string, queue?: string): ServiceGroup;
    }

    Hierarchy (View Summary)

    Index

    Methods

    • The name of the endpoint must be a simple subject token with no wildcards

      Parameters

      • name: string
      • Optionalopts: ServiceHandler | Partial<Endpoint>

        is either a handler or a more complex options which allows a subject, handler, and/or schema

      Returns QueuedIterator<ServiceMsg>

    • A group is a subject prefix from which endpoints can be added. Can be empty to allow for prefixes or tokens that are set at runtime without requiring editing of the service. Note that an optional queue can be specified, all endpoints added to the group, will use the specified queue unless the endpoint overrides it. When not set, it uses the parent group configuration. An empty string means no queue. see EndpointOptions and ServiceConfig.

      Parameters

      • Optionalsubject: string
      • Optionalqueue: string

      Returns ServiceGroup