StacOptions class

Immutable configuration for Stac projects and exports.

Use StacOptions to describe your project's identity and where Stac should read source files and write generated output.

Example:

const options = StacOptions(
  name: 'MyProject',
  projectId: 'my_project_id',
  // apiKey: '...optional...',
  // Override paths if needed (absolute or relative to your project root):
  // sourceDir: '/stac/',
  // outputDir: '/stac/.build',
);

Constructors

StacOptions.new({required String name, String? description, required String projectId, String sourceDir = '/stac/', String outputDir = '/stac/.build'})
Creates a StacOptions with the given configuration.
const

Properties

description String?
Optional short description of the project.
final
hashCode int
The hash code for this object.
no setterinherited
name String
Human‑readable project name.
final
outputDir String
Directory path where Stac generates build artifacts.
final
projectId String
Unique identifier for the project, used by tooling and integrations.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sourceDir String
Directory path where Stac source files are located.
final

Methods

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