# SpecIndexInterface

Chevere\Interfaces\Spec\SpecIndexInterface

view source (opens new window)

# Extends

# Description

Describes the component in charge of indexing endpoint specs for each route.

# Methods

# withAddedRoute

Return an instance with the specified $routeEndpointSpec for $routeName.

Parameters

  • routeName: string
  • routeEndpointSpec: Specs/RouteEndpointSpecInterface.md

Return

self

This method MUST retain the state of the current instance, and return an instance that contains the specified $routeEndpointSpec for $routeName.


# has

Indicates whether the instance has a route endpoint spec for $routeName at the given $methodName.

Parameters

  • routeName: string
  • methodName: string

Return

bool


# get

Returns the spec path.

Parameters

  • routeName: string
  • methodName: string

Return

string


# keys

Provides access to the object keys.

Return

array


# getGenerator

Provides the generator.


Last Updated: 5/1/2021, 2:31:10 PM