Config Class
Namespace
Statiq.Common
Base Types
  • object
graph BT Type-->Base0["object"] Type["Config"] class Type type-node

Syntax

public static class Config

Methods

Name Return Value Summary
ContainsAnySettings(string[]) Config<bool>
Creates a config value that returns true if the settings contains any of the specified keys.
static
ContainsSettings(string[]) Config<bool>
Creates a config value that returns true if the settings contains all the specified keys.
static
FromContext(Action<IExecutionContext>) Config<object>
Creates a config value from an action that uses the execution context and returns null.
static
FromContext(Func<IExecutionContext, Task>) Config<object>
Creates a config value from an action that uses the execution context and returns null.
static
FromContext<TValue>(Action<IExecutionContext>) Config<TValue>
Creates a config value from an action that uses the execution context and returns the default value of TValue.
static
FromContext<TValue>(Func<IExecutionContext, Task<TValue>>) Config<TValue>
Creates a config value from a delegate that uses the execution context.
static
FromContext<TValue>(Func<IExecutionContext, Task>) Config<TValue>
Creates a config value from an action that uses the execution context and returns the default value of TValue.
static
FromContext<TValue>(Func<IExecutionContext, TValue>) Config<TValue>
Creates a config value from a delegate that uses the execution context.
static
FromDocument(Action<IDocument, IExecutionContext>) Config<object>
Creates a config value from an action that uses a document and the execution context and returns null.
static
FromDocument(Action<IDocument>) Config<object>
Creates a config value from an action that uses a document and returns null.
static
FromDocument(Func<IDocument, IExecutionContext, Task>) Config<object>
Creates a config value from an action that uses a document and the execution context and returns null.
static
FromDocument(Func<IDocument, Task>) Config<object>
Creates a config value from an action that uses a document and returns null.
static
FromDocument(string, object) Config<object>
Creates a config value by getting the metadata value of a specified key from a document.
static
FromDocument<TValue>(Action<IDocument, IExecutionContext>) Config<TValue>
Creates a config value from an action that uses a document and the execution context and returns the default value of TValue.
static
FromDocument<TValue>(Action<IDocument>) Config<TValue>
Creates a config value from an action that uses a document and returns the default value of TValue.
static
FromDocument<TValue>(Func<IDocument, IExecutionContext, Task<TValue>>) Config<TValue>
Creates a config value from a delegate that uses a document and the execution context.
static
FromDocument<TValue>(Func<IDocument, IExecutionContext, Task>) Config<TValue>
Creates a config value from an action that uses a document and the execution context and returns the default value of TValue.
static
FromDocument<TValue>(Func<IDocument, IExecutionContext, TValue>) Config<TValue>
Creates a config value from a delegate that uses a document and the execution context.
static
FromDocument<TValue>(Func<IDocument, Task<TValue>>) Config<TValue>
Creates a config value from a delegate that uses a document.
static
FromDocument<TValue>(Func<IDocument, Task>) Config<TValue>
Creates a config value from an action that uses a document and returns the default value of TValue.
static
FromDocument<TValue>(Func<IDocument, TValue>) Config<TValue>
Creates a config value from a delegate that uses a document.
static
FromDocument<TValue>(string, TValue) Config<TValue>
Creates a config value by getting the metadata value of a specified key from a document.
static
FromDocument<TValue>(string) Config<TValue>
Creates a config value by getting the metadata value of a specified key from a document.
static
FromSetting(string, object) Config<object>
Creates a config value by getting the metadata value from the execution context of a specified key.
static
FromSetting(string, string) Config<string>
Creates a config value by getting the string metadata value from the execution context of a specified key.
static
FromSetting(string) Config<string>
Creates a config value by getting the string metadata value from the execution context of a specified key.
static
FromSetting<TValue>(string, TValue) Config<TValue>
Creates a config value by getting the metadata value from the execution context of a specified key.
static
FromSetting<TValue>(string) Config<TValue>
Creates a config value by getting the metadata value from the execution context of a specified key.
static
FromSettings(Action<IReadOnlySettings>) Config<object>
Creates a config value from an action that uses the settings and returns null.
static
FromSettings(Func<IReadOnlySettings, Task>) Config<object>
Creates a config value from an action that uses the settings and returns null.
static
FromSettings<TValue>(Action<IReadOnlySettings>) Config<TValue>
Creates a config value from an action that uses the settings and returns the default value of TValue.
static
FromSettings<TValue>(Func<IReadOnlySettings, Task<TValue>>) Config<TValue>
Creates a config value from a delegate that uses the settings.
static
FromSettings<TValue>(Func<IReadOnlySettings, Task>) Config<TValue>
Creates a config value from an action that uses the settings and returns the default value of TValue.
static
FromSettings<TValue>(Func<IReadOnlySettings, TValue>) Config<TValue>
Creates a config value from a delegate that uses the settings.
static
FromValue<TValue>(Task<TValue>) Config<TValue>
Creates a config value.
static
FromValue<TValue>(TValue) Config<TValue>
Creates a config value.
static
FromValues<TValue>(TValue[]) Config<IEnumerable<TValue>>
Creates an enumeration of config values.
static