DocVersionPolicy class

SEO policy governing versioned documentation portals (/docs/v1/, /docs/latest/).

Constructors

DocVersionPolicy({required String baseDocsUrl, String latestVersion = 'latest', List<String> supportedVersions = const ['latest', 'v1', 'v2', 'next'], bool canonicalizeToLatest = true, bool noindexOlderVersions = true})
const

Properties

baseDocsUrl → String
final
canonicalizeToLatest → bool
final
hashCode → int
The hash code for this object.
no setterinherited
latestVersion → String
final
noindexOlderVersions → bool
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
supportedVersions → List<String>
final

Methods

evaluate(String path) → DocVersionDecision
Evaluates an incoming documentation path (e.g. /docs/v1/getting-started/).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited