BasicProperty

@propertyWrapper
open class BasicProperty<Value, Formatter> : UpdatableProperty where Formatter : Formatter

extension BasicProperty: Equatable where Value: Equatable


                    
                    
                    wrappedValue

Declaration

Swift

public var wrappedValue: Value { get set }


                    
                    
                    projectedValue

Declaration

Swift

public var projectedValue: ReadOnlyProperty<BasicProperty<Value, Formatter>> { get }


                    
                    
                    asReadOnlyProperty

Declaration

Swift

public var asReadOnlyProperty: ReadOnlyProperty<BasicProperty<Value, Formatter>> { get }

`Property` Requirements

displayName
A human-friendly display name that describes the property.
Declaration
Swift

public let displayName: String


                    
                    
                    snapshot

The latest snapshot of data.

Declaration

Swift

@Published
public internal(set) var snapshot: Snapshot<Value> { get set }


                    
                    
                    value

The current value of the property.

Declaration

Swift

public internal(set) var value: Value { get set }

formatter
A formatter that can be used to build a human-friendly string from the value.
Declaration
Swift

public let formatter: Formatter


                    
                    
                    snapshotsPublisher

Declaration

Swift

public var snapshotsPublisher: AnyPublisher<Snapshot<Value>, Never> { get }

Initialisers


                    
                    
                    init(displayName:value:formatter:date:)

Declaration

Swift

public required init(
    displayName: String,
    value: Value,
    formatter: Formatter = Formatter(),
    date: Date = Date()
)

Update Functions


                    
                    
                    updateValue(_:date:)

Updates the value backing this Property.

Declaration

Swift

@discardableResult
public func updateValue(
    _ value: Value,
    date: Date
) -> Snapshot<Value>

Parameters

`value`	The new value of the property.
`date`	The date and time the `value` was recorded. Defaults to the current date and time.

Return Value

The new snapshot.

Available where `Value`: `Equatable`


                    
                    
                    ==(_:_:)

Declaration

Swift

public static func == (
    lhs: BasicProperty<Value, Formatter>, rhs: BasicProperty<Value, Formatter>
) -> Bool

Available where `Value`: `ExpressibleByNilLiteral`


                    
                    
                    init(displayName:optionalValue:formatter:date:)

Declaration

Swift

public convenience init(
    displayName: String,
    optionalValue: Value = nil,
    formatter: Formatter = Formatter(),
    date: Date = Date()
)

BasicProperty

Declaration

Declaration

Declaration

Property Requirements

Declaration

Declaration

Declaration

Declaration

Declaration

Initialisers

Declaration

Update Functions

Declaration

Parameters

Return Value

Available where Value: Equatable

Declaration

Available where Value: ExpressibleByNilLiteral

Declaration

`Property` Requirements

Available where `Value`: `Equatable`

Available where `Value`: `ExpressibleByNilLiteral`