SwiftConfig Docs (6% documented)

SwiftConfig Reference Config Struct Reference

Config

Undocumented

Lifecycle

Getter: single value

Getter: single untyped/uninitialized value

Getter: tuples

Getter: value as array

Getter: array of values for multiple keys

Getter: value at keypath

Getter: subconfig at keypath

Getter: subconfig from key

Getter: IConfigInitable object from subconfig at key

Getter: IConfigBuildable object from subconfig at key

Getter: array of subconfigs

Getter: dictionary of subconfigs

build an IConfigurableBuilder's product using all of the entries in this config

Pluck (narrows all layers to given keys)
  • pluck(_:)

    Undocumented

  • pluck(_:)

    Undocumented

  • pluck(_:)

    Undocumented

  • pluck(_:)

    Undocumented

  • flatten()

    Creates a Dictionary from all of the keys available in all layers of the Config object.Each key is paired with the value from the topmost layer that has that key. The dictionary returns the same values for each key as one would get from the Config’s get(key:) -> AnyObject? method. If you don’t need the underlying layers of a Config once it has been assembled, this can be a performance gain, as accessing a native Swift Dictionary is likely to be faster than Config.get.

    See more

    Declaration

    Swift

    public func flatten() -> [String: AnyObject]
  • set(_:value:)

    Adds the given key and value to the overrides layer, which is always preferred to other layers. This can be useful in a multi-stage initialization process if some initialized object must be passed to a subsequent initializer through a Config object (see IConfigInitable, IConfigRepresentable, IConfigurableBuilder, et. al).

    Declaration

    Swift

    public mutating func set(key:String, value:AnyObject?)
  • hasValueForKey(_:)

    Undocumented

Private helper methods
  • findLayerWithValueForKey(_:)

    Finds the topmost layer containing key and returns it. If no layers contained the key, this method returns nil.

    Declaration

    Swift

    public func findLayerWithValueForKey(key:String) -> IConfigLayer?