WIP: readme

This commit is contained in:
John Rommel Estropia
2017-05-24 00:33:43 +09:00
parent b9b96d1a35
commit 1a7a4690d1
3 changed files with 89 additions and 20 deletions

View File

@@ -41,6 +41,7 @@ public extension DynamicObject where Self: CoreStoreObject {
let pets = Relationship.ToManyUnordered<Dog>("pets", inverse: { $0.master })
}
```
- Important: `Relationship` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public typealias Relationship = RelationshipContainer<Self>
}
@@ -73,6 +74,7 @@ public enum RelationshipContainer<O: CoreStoreObject> {
let pets = Relationship.ToManyUnordered<Dog>("pets", inverse: { $0.master })
}
```
- Important: `Relationship.ToOne` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public final class ToOne<D: CoreStoreObject>: RelationshipProtocol {
@@ -251,6 +253,7 @@ public enum RelationshipContainer<O: CoreStoreObject> {
let pets = Relationship.ToManyOrdered<Dog>("pets", inverse: { $0.master })
}
```
- Important: `Relationship.ToManyOrdered` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public final class ToManyOrdered<D: CoreStoreObject>: RelationshipProtocol {
@@ -442,6 +445,7 @@ public enum RelationshipContainer<O: CoreStoreObject> {
let pets = Relationship.ToManyUnordered<Dog>("pets", inverse: { $0.master })
}
```
- Important: `Relationship.ToManyUnordered` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public final class ToManyUnordered<D: CoreStoreObject>: RelationshipProtocol {

View File

@@ -40,6 +40,7 @@ public extension DynamicObject where Self: CoreStoreObject {
let color = Transformable.Optional<UIColor>("color")
}
```
- Important: `Value` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public typealias Value = ValueContainer<Self>
@@ -52,6 +53,7 @@ public extension DynamicObject where Self: CoreStoreObject {
let color = Transformable.Optional<UIColor>("color")
}
```
- Important: `Transformable` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public typealias Transformable = TransformableContainer<Self>
}
@@ -82,6 +84,7 @@ public enum ValueContainer<O: CoreStoreObject> {
let color = Transformable.Optional<UIColor>("color")
}
```
- Important: `Value.Required` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public final class Required<V: ImportableAttributeType>: AttributeProtocol {
@@ -214,6 +217,7 @@ public enum ValueContainer<O: CoreStoreObject> {
let color = Transformable.Optional<UIColor>("color")
}
```
- Important: `Value.Optional` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public final class Optional<V: ImportableAttributeType>: AttributeProtocol {
@@ -360,6 +364,7 @@ public enum TransformableContainer<O: CoreStoreObject> {
let color = Transformable.Optional<UIColor>("color")
}
```
- Important: `Transformable.Required` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public final class Required<V: NSCoding & NSCopying>: AttributeProtocol {
@@ -485,6 +490,7 @@ public enum TransformableContainer<O: CoreStoreObject> {
let color = Transformable.Optional<UIColor>("color")
}
```
- Important: `Transformable.Optional` properties are required to be stored properties. Computed properties will be ignored, including `lazy` and `weak` properties.
*/
public final class Optional<V: NSCoding & NSCopying>: AttributeProtocol {