BloomRouteGroup class

Represents a scoped route group in BloomApiRouter sharing a URL prefix and middleware pipeline.

Route groups allow modular endpoint organization with nested prefix hierarchies and deterministic middleware inheritance.

Example

router.group('/api/v1', (v1) {
  v1.use(BloomCorsMiddleware());

  v1.get('/tasks', (req) async => BloomResponse.json(tasks));
  v1.post('/tasks', (req) async => BloomResponse.json(newTask, statusCode: 201));

  v1.group('/admin', (admin) {
    admin.delete('/cache', (req) async => BloomResponse.noContent());
  });
});

Properties

hashCode → int

The hash code for this object.

no setter, inherited

prefix → String

The resolved URL prefix for this route group.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

all(String path, BloomRouteHandler handler, {List<BloomMiddleware> middlewares = const []}) → void

Registers a route matching all HTTP methods within this group.

delete(String path, BloomRouteHandler handler, {List<BloomMiddleware> middlewares = const []}) → void

Registers a DELETE route within this group.

get(String path, BloomRouteHandler handler, {List<BloomMiddleware> middlewares = const []}) → void

Registers a GET route within this group.

group(String prefix, void configure(BloomRouteGroup group), {List<BloomMiddleware> middlewares = const []}) → void

Creates a nested route group within this group.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

options(String path, BloomRouteHandler handler, {List<BloomMiddleware> middlewares = const []}) → void

Registers an OPTIONS route within this group.

patch(String path, BloomRouteHandler handler, {List<BloomMiddleware> middlewares = const []}) → void

Registers a PATCH route within this group.

post(String path, BloomRouteHandler handler, {List<BloomMiddleware> middlewares = const []}) → void

Registers a POST route within this group.

put(String path, BloomRouteHandler handler, {List<BloomMiddleware> middlewares = const []}) → void

Registers a PUT route within this group.

ssr(String path, BloomNode builder(BloomRequest request), {HeadManager head(BloomRequest request)?, String layout(String bodyHtml, HeadManager? head)?, List<BloomMiddleware> middlewares = const []}) → void

Mounts a Server-Side Rendered (SSR) endpoint within this group.

toString() → String

A string representation of this object.

inherited

use(BloomMiddleware middleware) → void

Registers middleware scoped to all routes within this group and its subgroups.

Operators

operator ==(Object other) → bool

The equality operator.

inherited