From e52c324d797841b8a04438b991a5933345f4c08a Mon Sep 17 00:00:00 2001 From: Jesse Squires Date: Sun, 4 Nov 2018 19:47:55 -0800 Subject: [PATCH] [Docs] gen docs for 8.0 --- docs/Classes.html | 33 +-- docs/Classes/CoreDataStack.html | 84 +++--- docs/Enums.html | 75 ++---- docs/Enums/MigrationError.html | 52 +--- docs/Enums/ModelFileExtension.html | 68 ++--- docs/Enums/SaveResult.html | 52 +--- docs/Enums/StackResult.html | 56 ++-- docs/Enums/StoreType.html | 70 ++--- ...{Global Variables.html => Extensions.html} | 53 ++-- docs/Extensions/NSManagedObjectContext.html | 210 +++++++++++++++ docs/Functions.html | 243 ------------------ docs/Guides.html | 31 +-- docs/Protocols.html | 33 +-- docs/Protocols/CoreDataEntityProtocol.html | 58 ++--- docs/Structs.html | 77 ++---- docs/Structs/CoreDataModel.html | 124 ++++----- docs/Structs/CoreDataStackFactory.html | 125 ++++++--- docs/Typealiases.html | 193 -------------- docs/getting-started.html | 30 +-- docs/index.html | 47 +--- docs/search.json | 2 +- 21 files changed, 592 insertions(+), 1124 deletions(-) rename docs/{Global Variables.html => Extensions.html} (64%) create mode 100644 docs/Extensions/NSManagedObjectContext.html delete mode 100644 docs/Functions.html delete mode 100644 docs/Typealiases.html diff --git a/docs/Classes.html b/docs/Classes.html index 24dc6304..3b48b4f3 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -10,6 +10,7 @@ +
@@ -43,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -72,13 +65,10 @@
  • - Functions + Extensions
    • @@ -101,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -157,7 +136,7 @@

    Classes

    Declaration

    Swift

    - 
    public final class CoreDataStack: CustomStringConvertible, Equatable
    + 
    public final class CoreDataStack
    @@ -169,8 +148,8 @@

    Declaration

    diff --git a/docs/Classes/CoreDataStack.html b/docs/Classes/CoreDataStack.html index ac0f75c4..764ba5dd 100644 --- a/docs/Classes/CoreDataStack.html +++ b/docs/Classes/CoreDataStack.html @@ -44,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    CoreDataStack

    - 
    public final class CoreDataStack: CustomStringConvertible, Equatable
    + 
    public final class CoreDataStack
    @@ -153,9 +131,9 @@

    Properties

  • - + - model + model
    @@ -170,7 +148,7 @@

    Properties

    Declaration

    Swift

    - 
    public let model: CoreDataModel
    + 
    public let model: CoreDataModel
    @@ -180,9 +158,9 @@

    Declaration

  • - + - mainContext + mainContext
    @@ -191,15 +169,15 @@

    Declaration

    The main managed object context for the stack, which operates on the main queue. -This context is a root level context that is connected to the storeCoordinator. -It is kept in sync with backgroundContext.

    +This context is a root level context that is connected to the storeCoordinator. +It is kept in sync with backgroundContext.

    Declaration

    Swift

    - 
    public let mainContext: NSManagedObjectContext
    + 
    public let mainContext: NSManagedObjectContext
    @@ -209,9 +187,9 @@

    Declaration

  • - + - backgroundContext + backgroundContext
    @@ -220,15 +198,15 @@

    Declaration

    The background managed object context for the stack, which operates on a background queue. -This context is a root level context that is connected to the storeCoordinator. -It is kept in sync with mainContext.

    +This context is a root level context that is connected to the storeCoordinator. +It is kept in sync with mainContext.

    Declaration

    Swift

    - 
    public let backgroundContext: NSManagedObjectContext
    + 
    public let backgroundContext: NSManagedObjectContext
    @@ -238,9 +216,9 @@

    Declaration

  • - + - storeCoordinator + storeCoordinator
    @@ -255,7 +233,7 @@

    Declaration

    Declaration

    Swift

    - 
    public let storeCoordinator: NSPersistentStoreCoordinator
    + 
    public let storeCoordinator: NSPersistentStoreCoordinator
    @@ -276,9 +254,9 @@

    Child contexts

  • - + - childContext(concurrencyType:mergePolicyType:) + childContext(concurrencyType:mergePolicyType:)
    @@ -288,11 +266,11 @@

    Child contexts

    Creates a new child context with the specified concurrencyType and mergePolicyType.

    -

    The parent context is either mainContext or backgroundContext dependending on the specified concurrencyType:

    +

    The parent context is either mainContext or backgroundContext dependending on the specified concurrencyType:

    Saving the returned context will propagate changes through the parent context and then to the persistent store.

    @@ -302,8 +280,8 @@

    Child contexts

    Declaration

    Swift

    - 
    public func childContext(concurrencyType: NSManagedObjectContextConcurrencyType = .mainQueueConcurrencyType,
-                         mergePolicyType: NSMergePolicyType = .mergeByPropertyObjectTrumpMergePolicyType) -> ChildContext
    + 
    public func childContext(concurrencyType: NSManagedObjectContextConcurrencyType = .mainQueueConcurrencyType,
+                         mergePolicyType: NSMergePolicyType = .mergeByPropertyObjectTrumpMergePolicyType) -> NSManagedObjectContext.ChildContext
    @@ -348,9 +326,9 @@

    Return Value

  • - + - reset(onQueue:completion:) + reset(onQueue:completion:)
    @@ -373,7 +351,7 @@

    Return Value

    Declaration

    Swift

    - 
    public func reset(onQueue queue: DispatchQueue = .global(qos: .userInitiated),
+                          
    public func reset(onQueue queue: DispatchQueue = .global(qos: .userInitiated),
                   completion: @escaping (StackResult) -> Void)
    @@ -418,8 +396,8 @@

    Parameters

    • diff --git a/docs/Enums.html b/docs/Enums.html index 0a032cb5..f802dd28 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -10,6 +10,7 @@ +
    @@ -43,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -72,13 +65,10 @@
  • - Functions + Extensions
    • @@ -101,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -127,9 +106,9 @@

    Enumerations

  • @@ -137,15 +116,17 @@

    Enumerations

    -

    Describes a Core Data persistent store type.

    +

    Describes a Core Data model file exention type based on the +Model File Format and Versions +documentation.

    - See more + See more

    Declaration

    Swift

    - 
    public enum StoreType: Equatable
    + 
    public enum ModelFileExtension : String
    @@ -177,7 +158,7 @@

    Declaration

    Declaration

    Swift

    - 
    public enum MigrationError: Error
    + 
    public enum MigrationError : Error
    @@ -209,7 +190,7 @@

    Declaration

    Declaration

    Swift

    - 
    public enum SaveResult: Equatable
    + 
    public enum SaveResult : Equatable
    • @@ -223,9 +204,9 @@

    Declaration

  • @@ -233,17 +214,15 @@

    Declaration

    -

    Describes a Core Data model file exention type based on the -Model File Format and Versions -documentation.

    +

    A result object representing the result of creating a CoreDataStack via a CoreDataStackFactory.

    - See more + See more

    Declaration

    Swift

    - 
    public enum ModelFileExtension: String
    + 
    public enum StackResult : Equatable
    @@ -257,9 +236,9 @@

    Declaration

  • - - - StackResult + + + StoreType
    @@ -267,15 +246,15 @@

    Declaration

    -

    A result object representing the result of creating a CoreDataStack via a CoreDataStackFactory.

    +

    Describes a Core Data persistent store type.

    - See more + See more

    Declaration

    Swift

    - 
    public enum StackResult: Equatable
    + 
    public enum StoreType : Equatable
    @@ -287,8 +266,8 @@

    Declaration

    • diff --git a/docs/Enums/MigrationError.html b/docs/Enums/MigrationError.html index 11af5582..ed9aab76 100644 --- a/docs/Enums/MigrationError.html +++ b/docs/Enums/MigrationError.html @@ -44,14 +44,6 @@
    • -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    MigrationError

    - 
    public enum MigrationError: Error
    + 
    public enum MigrationError : Error
    @@ -134,9 +112,9 @@

    MigrationError

  • @@ -151,7 +129,7 @@

    MigrationError

    Declaration

    Swift

    - 
    case sourceModelNotFound(model: CoreDataModel)
    + 
    case sourceModelNotFound(model: CoreDataModel)
    @@ -177,16 +155,12 @@

    Parameters

    • - - -
    -
    diff --git a/docs/Enums/ModelFileExtension.html b/docs/Enums/ModelFileExtension.html index 9e32b040..70386a57 100644 --- a/docs/Enums/ModelFileExtension.html +++ b/docs/Enums/ModelFileExtension.html @@ -44,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    ModelFileExtension

    - 
    public enum ModelFileExtension: String
    + 
    public enum ModelFileExtension : String
    @@ -136,9 +114,9 @@

    ModelFileExtension

  • - + - bundle + bundle
    @@ -153,23 +131,19 @@

    ModelFileExtension

    Declaration

    Swift

    - 
    case bundle = "momd"
    + 
    case bundle = "momd"
    • - - -
    -
    • @@ -184,23 +158,19 @@

      Declaration

      Declaration

      Swift

      - 
      case versionedFile = "mom"
      + 
      case versionedFile = "mom"
    - - -
    -
    • - + - mapping + mapping
      @@ -215,23 +185,19 @@

      Declaration

      Declaration

      Swift

      - 
      case mapping = "cdm"
      + 
      case mapping = "cdm"
    - - -
    -
    diff --git a/docs/Enums/SaveResult.html b/docs/Enums/SaveResult.html index 6e3ba9b9..fe435f30 100644 --- a/docs/Enums/SaveResult.html +++ b/docs/Enums/SaveResult.html @@ -44,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    SaveResult

    - 
    public enum SaveResult: Equatable
    + 
    public enum SaveResult : Equatable
    @@ -134,9 +112,9 @@

    SaveResult

  • - + - success + success
    @@ -151,23 +129,19 @@

    SaveResult

    Declaration

    Swift

    - 
    case success
    + 
    case success
    • - - -
    -
    • - - - failure + + + failure(_:)
      @@ -182,7 +156,7 @@

      Declaration

      Declaration

      Swift

      - 
      case failure(NSError)
      + 
      case failure(NSError)
      @@ -219,7 +193,7 @@

      Methods

      Declaration

      Swift

      - 
      public func error() -> NSError?
      + 
      public func error() -> NSError?
    @@ -235,8 +209,8 @@

    Return Value

    diff --git a/docs/Enums/StackResult.html b/docs/Enums/StackResult.html index 21e5a81f..a6eacc48 100644 --- a/docs/Enums/StackResult.html +++ b/docs/Enums/StackResult.html @@ -44,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    StackResult

    - 
    public enum StackResult: Equatable
    + 
    public enum StackResult : Equatable
    @@ -134,9 +112,9 @@

    StackResult

  • - - - success + + + success(_:)
    @@ -151,23 +129,19 @@

    StackResult

    Declaration

    Swift

    - 
    case success(CoreDataStack)
    + 
    case success(CoreDataStack)
    • - - -
    -
    • - - - failure + + + failure(_:)
      @@ -182,7 +156,7 @@

      Declaration

      Declaration

      Swift

      - 
      case failure(NSError)
      + 
      case failure(NSError)
      @@ -219,7 +193,7 @@

      Methods

      Declaration

      Swift

      - 
      public func stack() -> CoreDataStack?
      + 
      public func stack() -> CoreDataStack?
    @@ -249,7 +223,7 @@

    Return Value

    Declaration

    Swift

    - 
    public func error() -> NSError?
    + 
    public func error() -> NSError?
    @@ -265,8 +239,8 @@

    Return Value

    diff --git a/docs/Enums/StoreType.html b/docs/Enums/StoreType.html index c2f8b5e5..739c5bc0 100644 --- a/docs/Enums/StoreType.html +++ b/docs/Enums/StoreType.html @@ -44,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    StoreType

    - 
    public enum StoreType: Equatable
    + 
    public enum StoreType : Equatable
    @@ -134,9 +112,9 @@

    StoreType

  • - - - sqlite + + + sqlite(_:)
    @@ -151,23 +129,19 @@

    StoreType

    Declaration

    Swift

    - 
    case sqlite(URL)
    + 
    case sqlite(URL)
    • - - -
    -
    • - - - binary + + + binary(_:)
      @@ -182,23 +156,19 @@

      Declaration

      Declaration

      Swift

      - 
      case binary(URL)
      + 
      case binary(URL)
    - - -
    -
    • - + - inMemory + inMemory
      @@ -213,7 +183,7 @@

      Declaration

      Declaration

      Swift

      - 
      case inMemory
      + 
      case inMemory
      @@ -234,9 +204,9 @@

      Properties

    • - + - type + type
      @@ -251,7 +221,7 @@

      Properties

      Declaration

      Swift

      - 
      public var type: String
      + 
      public var type: String { get }
      @@ -293,7 +263,7 @@

      Methods

      Declaration

      Swift

      - 
      public func storeDirectory() -> URL?
      + 
      public func storeDirectory() -> URL?
    @@ -309,8 +279,8 @@

    Return Value

    diff --git a/docs/Global Variables.html b/docs/Extensions.html similarity index 64% rename from docs/Global Variables.html rename to docs/Extensions.html index 6afdd638..76bc796d 100644 --- a/docs/Global Variables.html +++ b/docs/Extensions.html @@ -1,7 +1,7 @@ - Global Variables Reference + Extensions Reference @@ -10,7 +10,8 @@ - + +

    JSQCoreDataKit Docs (100% documented)

    @@ -21,7 +22,7 @@
    @@ -43,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -72,13 +65,10 @@
  • - Functions + Extensions
    • @@ -101,24 +91,13 @@ -
  • - Type Aliases - -
    • -

    Global Variables

    -

    The following global variables are available globally.

    +

    Extensions

    +

    The following extensions are available globally.

    @@ -127,9 +106,9 @@

    Global Variables

  • @@ -137,14 +116,14 @@

    Global Variables

    -

    Describes default persistent store options.

    - + + See more

    Declaration

    Swift

    - 
    public let defaultStoreOptions: PersistentStoreOptions = [
    + 
    class NSManagedObjectContext : NSObject, NSCoding, NSLocking
    @@ -156,8 +135,8 @@

    Declaration

    • diff --git a/docs/Extensions/NSManagedObjectContext.html b/docs/Extensions/NSManagedObjectContext.html new file mode 100644 index 00000000..7cab4be5 --- /dev/null +++ b/docs/Extensions/NSManagedObjectContext.html @@ -0,0 +1,210 @@ + + + + NSManagedObjectContext Extension Reference + + + + + + + + + + +
    +
    +

    JSQCoreDataKit Docs (100% documented)

    +

    View on GitHub

    +
    +
    +
    + +
    +
    + +
    +
    +
    +

    NSManagedObjectContext

    +
    +
    + 
    class NSManagedObjectContext : NSObject, NSCoding, NSLocking
    + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + ChildContext + +
      +
      +
      +
      +
      +
      +

      Describes a child managed object context.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public typealias ChildContext = NSManagedObjectContext
      + +
      +
      +
      +
      +
      • +
    • + +
      +
      +
      +
      +
      +

      Attempts to commit unsaved changes to registered objects in the context. +This function is performed in a block on the context’s queue. If the context has no changes, +then this function returns immediately and the completion block is not called.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func save(wait: Bool = true, completion: ((SaveResult) -> Void)? = nil)
      + +
      +
      +
      +

      Parameters

      + + + + + + + + + + + +
      + + wait + + +
      +

      If true (the default), saves synchronously. If false, saves asynchronously.

      +
      +
      + + completion + + +
      +

      The closure to be executed when the save operation completes.

      +
      +
      +
      +
      +
      +
      • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docs/Functions.html b/docs/Functions.html deleted file mode 100644 index 838e6b54..00000000 --- a/docs/Functions.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - Functions Reference - - - - - - - - - -
    -
    -

    JSQCoreDataKit Docs (100% documented)

    -

    View on GitHub

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    Functions

    -

    The following functions are available globally.

    - -
    -
    -
    -
      -
    • -
      - - - - defaultDirectoryURL() - -
      -
      -
      -
      -
      -
      -

      The default directory used to initialize a CoreDataModel. -On tvOS, this is the caches directory. All other platforms use the document directory.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public func defaultDirectoryURL() -> URL
      - -
      -
      -
      -
      -
      • -
    -
    -
    -
      -
    • - -
      -
      -
      -
      -
      -

      Attempts to commit unsaved changes to registered objects in the context. -This function is performed in a block on the context’s queue. If the context has no changes, -then this function returns immediately and the completion block is not called.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public func saveContext(_ context: NSManagedObjectContext, wait: Bool = true, completion: ((SaveResult) -> Void)? = nil)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - - - - - -
      - - context - - -
      -

      The managed object context to save.

      -
      -
      - - wait - - -
      -

      If true (the default), saves synchronously. If false, saves asynchronously.

      -
      -
      - - completion - - -
      -

      The closure to be executed when the save operation completes.

      -
      -
      -
      -
      -
      -
      • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/Guides.html b/docs/Guides.html index 2d60efc5..71fee4c3 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -10,6 +10,7 @@ +
    @@ -43,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -72,13 +65,10 @@
  • - Functions + Extensions
    • @@ -101,17 +91,6 @@ -
  • - Type Aliases - -
    • diff --git a/docs/Protocols.html b/docs/Protocols.html index 4b6eee1f..3bf98b8e 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -10,6 +10,7 @@ +
    @@ -43,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -72,13 +65,10 @@
  • - Functions + Extensions
    • @@ -101,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -145,7 +124,7 @@

    Protocols

    Declaration

    Swift

    - 
    public protocol CoreDataEntityProtocol: class
    + 
    public protocol CoreDataEntityProtocol : AnyObject
    @@ -157,8 +136,8 @@

    Declaration

    diff --git a/docs/Protocols/CoreDataEntityProtocol.html b/docs/Protocols/CoreDataEntityProtocol.html index e661092c..d6b39be0 100644 --- a/docs/Protocols/CoreDataEntityProtocol.html +++ b/docs/Protocols/CoreDataEntityProtocol.html @@ -44,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    CoreDataEntityProtocol

    - 
    public protocol CoreDataEntityProtocol: class
    + 
    public protocol CoreDataEntityProtocol : AnyObject
    @@ -134,9 +112,9 @@

    CoreDataEntityProtocol

  • - + - entityName + entityName Default implementation @@ -159,7 +137,7 @@

    Default Implementation

    Declaration

    Swift

    - 
    static var entityName: String
    + 
    static var entityName: String { get }
    @@ -169,9 +147,9 @@

    Declaration

  • @@ -186,7 +164,7 @@

    Declaration

    Declaration

    Swift

    - 
    static var defaultSortDescriptors: [NSSortDescriptor]
    + 
    static var defaultSortDescriptors: [NSSortDescriptor] { get }
    @@ -200,9 +178,9 @@

    Declaration

  • - + - fetchRequest + fetchRequest Extension method @@ -213,14 +191,14 @@

    Declaration

    -

    Returns a new fetch request with defaultSortDescriptors.

    +

    Returns a new fetch request with defaultSortDescriptors.

    Declaration

    Swift

    - 
    public static var fetchRequest: NSFetchRequest<Self>
    + 
    public static var fetchRequest: NSFetchRequest<Self> { get }
    @@ -230,9 +208,9 @@

    Declaration

  • - + - entity(context:) + entity(context:) Extension method @@ -251,7 +229,7 @@

    Declaration

    Declaration

    Swift

    - 
    public static func entity(context: NSManagedObjectContext) -> NSEntityDescription
    + 
    public static func entity(context: NSManagedObjectContext) -> NSEntityDescription
    @@ -286,8 +264,8 @@

    Return Value

    • diff --git a/docs/Structs.html b/docs/Structs.html index b9213f77..2e1e35e5 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -10,6 +10,7 @@ +
    @@ -43,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -72,13 +65,10 @@
  • - Functions + Extensions
    • @@ -101,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -127,9 +106,9 @@

    Structures

  • @@ -137,25 +116,16 @@

    Structures

    -

    An instance of CoreDataStackFactory is responsible for creating instances of CoreDataStack.

    - -

    Because the adding of the persistent store to the persistent store coordinator during initialization -of a CoreDataStack can take an unknown amount of time, you should not perform this operation on the main queue.

    - -

    See this guide for more details.

    -
    -

    Warning

    - You should not create instances of CoreDataStack directly. Use a CoreDataStackFactory instead. - -
    +

    An instance of CoreDataModel represents a Core Data model — a .xcdatamodeld file package. +It provides the model and store URLs as well as methods for interacting with the store.

    - See more + See more

    Declaration

    Swift

    - 
    public struct CoreDataStackFactory: Equatable
    + 
    public struct CoreDataModel
    @@ -169,9 +139,9 @@

    Declaration

  • @@ -179,16 +149,25 @@

    Declaration

    -

    An instance of CoreDataModel represents a Core Data model — a .xcdatamodeld file package. -It provides the model and store URLs as well as methods for interacting with the store.

    +

    An instance of CoreDataStackFactory is responsible for creating instances of CoreDataStack.

    - See more +

    Because the adding of the persistent store to the persistent store coordinator during initialization +of a CoreDataStack can take an unknown amount of time, you should not perform this operation on the main queue.

    + +

    See this guide for more details.

    +
    +

    Warning

    + You should not create instances of CoreDataStack directly. Use a CoreDataStackFactory instead. + +
    + + See more

    Declaration

    Swift

    - 
    public struct CoreDataModel: Equatable
    + 
    public struct CoreDataStackFactory
    @@ -200,8 +179,8 @@

    Declaration

    • diff --git a/docs/Structs/CoreDataModel.html b/docs/Structs/CoreDataModel.html index fa5ef5d5..fa4ef9cd 100644 --- a/docs/Structs/CoreDataModel.html +++ b/docs/Structs/CoreDataModel.html @@ -44,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    CoreDataModel

    - 
    public struct CoreDataModel: Equatable
    + 
    public struct CoreDataModel
    @@ -142,9 +120,9 @@

    Properties

  • - + - name + name
    @@ -159,7 +137,7 @@

    Properties

    Declaration

    Swift

    - 
    public let name: String
    + 
    public let name: String
    @@ -169,9 +147,9 @@

    Declaration

  • - + - bundle + bundle
    @@ -186,7 +164,7 @@

    Declaration

    Declaration

    Swift

    - 
    public let bundle: Bundle
    + 
    public let bundle: Bundle
    @@ -196,9 +174,9 @@

    Declaration

  • @@ -213,7 +191,7 @@

    Declaration

    Declaration

    Swift

    - 
    public let storeType: StoreType
    + 
    public let storeType: StoreType
    @@ -223,9 +201,9 @@

    Declaration

  • - + - storeURL + storeURL
    @@ -245,7 +223,7 @@

    Declaration

    Declaration

    Swift

    - 
    public var storeURL: URL?
    + 
    public var storeURL: URL? { get }
    @@ -255,9 +233,9 @@

    Declaration

  • - + - modelURL + modelURL
    @@ -265,14 +243,14 @@

    Declaration

    -

    The file URL specifying the model file in the bundle specified by bundle.

    +

    The file URL specifying the model file in the bundle specified by bundle.

    Declaration

    Swift

    - 
    public var modelURL: URL
    + 
    public var modelURL: URL { get }
    @@ -282,9 +260,9 @@

    Declaration

  • @@ -299,7 +277,7 @@

    Declaration

    Declaration

    Swift

    - 
    public var databaseFileName: String
    + 
    public var databaseFileName: String { get }
    @@ -309,9 +287,9 @@

    Declaration

  • @@ -319,14 +297,14 @@

    Declaration

    -

    The managed object model for the model specified by name.

    +

    The managed object model for the model specified by name.

    Declaration

    Swift

    - 
    public var managedObjectModel: NSManagedObjectModel
    + 
    public var managedObjectModel: NSManagedObjectModel { get }
    @@ -336,9 +314,9 @@

    Declaration

  • @@ -354,7 +332,7 @@

    Declaration

    Declaration

    Swift

    - 
    public var needsMigration: Bool
    + 
    public var needsMigration: Bool { get }
    @@ -379,9 +357,9 @@

    Initialization

  • @@ -396,7 +374,7 @@

    Initialization

    Declaration

    Swift

    - 
    public init(name: String, bundle: Bundle = .main, storeType: StoreType = .sqlite(defaultDirectoryURL()))
    + 
    public init(name: String, bundle: Bundle = .main, storeType: StoreType = .sqlite(defaultDirectoryURL()))
    @@ -486,7 +464,35 @@

    Methods

    Declaration

    Swift

    - 
    public func removeExistingStore() throws
    + 
    public func removeExistingStore() throws
    + +
    +
    • +
    • +
    +
    • +
  • +
    + + + + defaultDirectoryURL() + +
    +
    +
    +
    +
    +
    +

    The default directory used to initialize a CoreDataModel. +On tvOS, this is the caches directory. All other platforms use the document directory.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static func defaultDirectoryURL() -> URL
    @@ -511,7 +517,7 @@

    Declaration

    Progressively migrates the persistent store of the CoreDataModel based on mapping models found in the model’s bundle. -If the model returns false from needsMigration, then this function does nothing.

    +If the model returns false from needsMigration, then this function does nothing.

    Throws

    If an error occurs, either an NSError or a MigrationError is thrown. If an NSError is thrown, it could @@ -531,7 +537,7 @@

    Declaration

    Declaration

    Swift

    - 
    public func migrate() throws
    + 
    public func migrate() throws
    @@ -543,8 +549,8 @@

    Declaration

    • diff --git a/docs/Structs/CoreDataStackFactory.html b/docs/Structs/CoreDataStackFactory.html index 20b93c7f..0ffabba9 100644 --- a/docs/Structs/CoreDataStackFactory.html +++ b/docs/Structs/CoreDataStackFactory.html @@ -44,14 +44,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -73,13 +65,10 @@
  • - Functions + Extensions
    • @@ -102,17 +91,6 @@ -
  • - Type Aliases - -
    • @@ -121,7 +99,7 @@

    CoreDataStackFactory

    - 
    public struct CoreDataStackFactory: Equatable
    + 
    public struct CoreDataStackFactory
    @@ -139,6 +117,44 @@

    CoreDataStackFactory

    +
    +
    + + + +

    Typealiases

    +     +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Describes the initialization options for a persistent store.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public typealias PersistentStoreOptions = [AnyHashable : Any]
      + +
      +
      +
      +
      +
      • +
    +
    @@ -151,9 +167,36 @@

    Properties

  • - + + + defaultStoreOptions + +
    +
    +
    +
    +
    +
    +

    Describes default persistent store options.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let defaultStoreOptions: CoreDataStackFactory.PersistentStoreOptions
    + +
    +
    +
    +
    +
    • +
  • +
    + + - model + model
    @@ -168,7 +211,7 @@

    Properties

    Declaration

    Swift

    - 
    public let model: CoreDataModel
    + 
    public let model: CoreDataModel
    @@ -178,9 +221,9 @@

    Declaration

  • - + - options + options
    @@ -196,7 +239,7 @@

    Declaration

    Declaration

    Swift

    - 
    public let options: PersistentStoreOptions?
    + 
    public let options: PersistentStoreOptions?
    @@ -217,9 +260,9 @@

    Initialization

  • @@ -227,14 +270,14 @@

    Initialization

    -

    Constructs a new CoreDataStackFactory instance with the specified model and options.

    +

    Constructs a new CoreDataStackFactory instance with the specified model and options.

    Declaration

    Swift

    - 
    public init(model: CoreDataModel, options: PersistentStoreOptions? = defaultStoreOptions)
    + 
    public init(model: CoreDataModel, options: PersistentStoreOptions? = defaultStoreOptions)
    @@ -290,9 +333,9 @@

    Creating a stack

  • @@ -300,7 +343,7 @@

    Creating a stack

    -

    Initializes a new CoreDataStack instance using the factory’s model and options.

    +

    Initializes a new CoreDataStack instance using the factory’s model and options.

    Warning

    If a queue is provided, this operation is performed asynchronously on the specified queue, @@ -314,7 +357,7 @@

    Creating a stack

    Declaration

    Swift

    - 
    public func createStack(onQueue queue: DispatchQueue? = .global(qos: .userInitiated),
+                          
    public func createStack(onQueue queue: DispatchQueue? = .global(qos: .userInitiated),
                         completion: @escaping (StackResult) -> Void)
    @@ -362,8 +405,8 @@

    Parameters

    • diff --git a/docs/Typealiases.html b/docs/Typealiases.html deleted file mode 100644 index e701f479..00000000 --- a/docs/Typealiases.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - Type Aliases Reference - - - - - - - - - -
    -
    -

    JSQCoreDataKit Docs (100% documented)

    -

    View on GitHub

    -
    -
    -
    - -
    -
    - -
    -
    -
    -

    Type Aliases

    -

    The following type aliases are available globally.

    - -
    -
    -
    -
      -
    • -
      - - - - ChildContext - -
      -
      -
      -
      -
      -
      -

      Describes a child managed object context.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public typealias ChildContext = NSManagedObjectContext
      - -
      -
      -
      -
      -
      • -
    • - -
      -
      -
      -
      -
      -

      Describes the initialization options for a persistent store.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public typealias PersistentStoreOptions = [AnyHashable : AnyObject]
      - -
      -
      -
      -
      -
      • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docs/getting-started.html b/docs/getting-started.html index bdf85338..db4dba63 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -43,14 +43,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -72,13 +64,10 @@
  • - Functions + Extensions
    • @@ -101,17 +90,6 @@ -
  • - Type Aliases - -
    • diff --git a/docs/index.html b/docs/index.html index 84e1a92d..0bf99e53 100644 --- a/docs/index.html +++ b/docs/index.html @@ -43,14 +43,6 @@ -
  • - Global Variables - -
  • Enumerations
      @@ -72,13 +64,10 @@
  • - Functions + Extensions
    • @@ -101,17 +90,6 @@ -
  • - Type Aliases - -
    • @@ -151,12 +129,13 @@

    About

    Requirements

      -
    • Xcode 9+
      • -
    • Swift 4.0+
      • -
    • iOS 9.0+
      • -
    • macOS 10.11+
      • -
    • tvOS 10.0+
      • -
    • watchOS 3.0+
      • +
    • Xcode 10+
      • +
    • Swift 4.2+
      • +
    • iOS 11.0+
      • +
    • macOS 10.12+
      • +
    • tvOS 11.0+
      • +
    • watchOS 4.0+
      • +
    • SwiftLint

    Installation

    @@ -175,10 +154,10 @@

    Documentation

    Read the docs. Generated with jazzy. Hosted by GitHub Pages.

    Generate

    -
    $ ./build_docs.sh
+
    $ ./scripts/build_docs.sh
 
    
 
    Preview
    
-
    $ open index.html -a Safari
+
    $ open index.html -a Safari
 
    
 
    Contribute
    
 
@@ -199,8 +178,8 @@ 
    License
    diff --git a/docs/search.json b/docs/search.json index f91e9a44..dbb9dad0 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:14JSQCoreDataKit12ChildContexta":{"name":"ChildContext","abstract":"

    Describes a child managed object context.

    "},"Typealiases.html#/s:14JSQCoreDataKit22PersistentStoreOptionsa":{"name":"PersistentStoreOptions","abstract":"

    Describes the initialization options for a persistent store.

    "},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV4nameSSv":{"name":"name","abstract":"

    The name of the Core Data model resource.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV6bundleSo6BundleCv":{"name":"bundle","abstract":"

    The bundle in which the model is located.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV9storeTypeAA05StoreG0Ov":{"name":"storeType","abstract":"

    The type of the Core Data persistent store for the model.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV8storeURL10Foundation0G0VSgv":{"name":"storeURL","abstract":"

    The file URL specifying the full path to the store.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV8modelURL10Foundation0G0Vv":{"name":"modelURL","abstract":"

    The file URL specifying the model file in the bundle specified by bundle.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV16databaseFileNameSSv":{"name":"databaseFileName","abstract":"

    The database file name for the store.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV013managedObjectE0So09NSManagedgE0Cv":{"name":"managedObjectModel","abstract":"

    The managed object model for the model specified by name.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV14needsMigrationSbv":{"name":"needsMigration","abstract":"

    Queries the meta data for the persistent store specified by the receiver","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelVACSS4name_So6BundleC6bundleAA9StoreTypeO05storeJ0tcfc":{"name":"init(name:bundle:storeType:)","abstract":"

    Constructs a new CoreDataModel instance with the specified name and bundle.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV19removeExistingStoreyyKF":{"name":"removeExistingStore()","abstract":"

    Removes the existing model store specfied by the receiver.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV7migrateyyKF":{"name":"migrate()","abstract":"

    Progressively migrates the persistent store of the CoreDataModel based on mapping models found in the model’s bundle.","parent_name":"CoreDataModel"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV5modelAA0dB5ModelVv":{"name":"model","abstract":"

    The model for the stack that the factory produces.

    ","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV7optionss10DictionaryVys11AnyHashableVyXlGSgv":{"name":"options","abstract":"

    A dictionary that specifies options for the store that the factory produces.","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryVAcA0dB5ModelV5model_s10DictionaryVys11AnyHashableVyXlGSg7optionstcfc":{"name":"init(model:options:)","abstract":"

    Constructs a new CoreDataStackFactory instance with the specified model and options.

    ","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV06createE0ySo13DispatchQueueCSg02onI0_yAA0E6ResultOc10completiontF":{"name":"createStack(onQueue:completion:)","abstract":"

    Initializes a new CoreDataStack instance using the factory’s model and options.

    ","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html":{"name":"CoreDataStackFactory","abstract":"

    An instance of CoreDataStackFactory is responsible for creating instances of CoreDataStack.

    "},"Structs/CoreDataModel.html":{"name":"CoreDataModel","abstract":"

    An instance of CoreDataModel represents a Core Data model — a .xcdatamodeld file package."},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolP10entityNameSSvZ":{"name":"entityName","abstract":"

    The name of the entity.

    ","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolP22defaultSortDescriptorsSaySo16NSSortDescriptorCGvZ":{"name":"defaultSortDescriptors","abstract":"

    The default sort descriptors for a fetch request.

    ","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolPAASo15NSManagedObjectCRbzAaBRzlE12fetchRequestSo07NSFetchJ0CyxGvZ":{"name":"fetchRequest","abstract":"

    Returns a new fetch request with defaultSortDescriptors.

    ","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolPAASo15NSManagedObjectCRbzAaBRzlE6entitySo19NSEntityDescriptionCSo0gH7ContextC7context_tFZ":{"name":"entity(context:)","abstract":"

    Returns the entity with the specified name from the managed object model associated","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html":{"name":"CoreDataEntityProtocol","abstract":"

    Describes an entity in Core Data.

    "},"Functions.html#/s:14JSQCoreDataKit19defaultDirectoryURL10Foundation0F0VyF":{"name":"defaultDirectoryURL()","abstract":"

    The default directory used to initialize a CoreDataModel."},"Functions.html#/s:14JSQCoreDataKit11saveContextySo015NSManagedObjectE0C_Sb4waityAA10SaveResultOcSg10completiontF":{"name":"saveContext(_:wait:completion:)","abstract":"

    Attempts to commit unsaved changes to registered objects in the context."},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO7successAcA04CorebD0CcACmF":{"name":"success","abstract":"

    The success result, containing the successfully initialized CoreDataStack.

    ","parent_name":"StackResult"},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO7failureACSo7NSErrorCcACmF":{"name":"failure","abstract":"

    The failure result, containing an NSError instance that describes the error.

    ","parent_name":"StackResult"},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO5stackAA04CorebD0CSgyF":{"name":"stack()","parent_name":"StackResult"},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO5errorSo7NSErrorCSgyF":{"name":"error()","parent_name":"StackResult"},"Enums/ModelFileExtension.html#/s:14JSQCoreDataKit18ModelFileExtensionO6bundleA2CmF":{"name":"bundle","abstract":"

    The extension for a model bundle, or a .xcdatamodeld file package.

    ","parent_name":"ModelFileExtension"},"Enums/ModelFileExtension.html#/s:14JSQCoreDataKit18ModelFileExtensionO09versionedE0A2CmF":{"name":"versionedFile","abstract":"

    The extension for a versioned model file, or a .xcdatamodel file.

    ","parent_name":"ModelFileExtension"},"Enums/ModelFileExtension.html#/s:14JSQCoreDataKit18ModelFileExtensionO7mappingA2CmF":{"name":"mapping","abstract":"

    The extension for a mapping model file, or a .xcmappingmodel file.

    ","parent_name":"ModelFileExtension"},"Enums/ModelFileExtension.html#/s:14JSQCoreDataKit18ModelFileExtensionO6sqliteA2CmF":{"name":"sqlite","abstract":"

    The extension for a sqlite store.

    ","parent_name":"ModelFileExtension"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO7successA2CmF":{"name":"success","abstract":"

    The success result.

    ","parent_name":"SaveResult"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO7failureACSo7NSErrorCcACmF":{"name":"failure","abstract":"

    The failure result, containing an NSError instance that describes the error.

    ","parent_name":"SaveResult"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO5errorSo7NSErrorCSgyF":{"name":"error()","parent_name":"SaveResult"},"Enums/MigrationError.html#/s:14JSQCoreDataKit14MigrationErrorO19sourceModelNotFoundAcA04CorebG0V5model_tcACmF":{"name":"sourceModelNotFound","abstract":"

    Specifies that the NSManagedObjectModel corresponding to the existing persistent store was not found in the model’s bundle.

    ","parent_name":"MigrationError"},"Enums/MigrationError.html#/s:14JSQCoreDataKit14MigrationErrorO20mappingModelNotFoundACSo015NSManagedObjectG0C011destinationG0_tcACmF":{"name":"mappingModelNotFound","abstract":"

    Specifies that an NSMappingModel was not found in the model’s bundle in the progressive migration ‘path’.

    ","parent_name":"MigrationError"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO6sqliteAC10Foundation3URLVcACmF":{"name":"sqlite","abstract":"

    The SQLite database store type. The associated file URL specifies the directory for the store.

    ","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO6binaryAC10Foundation3URLVcACmF":{"name":"binary","abstract":"

    The binary store type. The associated file URL specifies the directory for the store.

    ","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO8inMemoryA2CmF":{"name":"inMemory","abstract":"

    The in-memory store type.

    ","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO4typeSSv":{"name":"type","abstract":"

    Returns the type string description for the store type.

    ","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO14storeDirectory10Foundation3URLVSgyF":{"name":"storeDirectory()","abstract":"
    ","parent_name":"StoreType"},"Enums/StoreType.html":{"name":"StoreType","abstract":"

    Describes a Core Data persistent store type.

    "},"Enums/MigrationError.html":{"name":"MigrationError","abstract":"

    An error type that specifies possible errors that are thrown by calling CoreDataModel.migrate() throws.

    "},"Enums/SaveResult.html":{"name":"SaveResult","abstract":"

    A result object representing the result of saving an NSManagedObjectContext.

    "},"Enums/ModelFileExtension.html":{"name":"ModelFileExtension","abstract":"

    Describes a Core Data model file exention type based on the"},"Enums/StackResult.html":{"name":"StackResult","abstract":"

    A result object representing the result of creating a CoreDataStack via a CoreDataStackFactory.

    "},"Global Variables.html#/s:14JSQCoreDataKit19defaultStoreOptionss10DictionaryVys11AnyHashableVyXlGv":{"name":"defaultStoreOptions","abstract":"

    Describes default persistent store options.

    "},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC5modelAA0dB5ModelVv":{"name":"model","abstract":"

    The model for the stack.

    ","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC11mainContextSo015NSManagedObjectG0Cv":{"name":"mainContext","abstract":"

    The main managed object context for the stack, which operates on the main queue.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC17backgroundContextSo015NSManagedObjectG0Cv":{"name":"backgroundContext","abstract":"

    The background managed object context for the stack, which operates on a background queue.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC16storeCoordinatorSo017NSPersistentStoreG0Cv":{"name":"storeCoordinator","abstract":"

    The persistent store coordinator for the stack. Both contexts are connected to this coordinator.

    ","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC12childContextSo015NSManagedObjectG0CSC0hiG15ConcurrencyTypeO011concurrencyK0_SC013NSMergePolicyK0O05mergenK0tF":{"name":"childContext(concurrencyType:mergePolicyType:)","abstract":"

    Creates a new child context with the specified concurrencyType and mergePolicyType.

    ","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC5resetySo13DispatchQueueC02onH0_yAA0E6ResultOc10completiontF":{"name":"reset(onQueue:completion:)","abstract":"

    Resets the managed object contexts in the stack on their respective threads.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html":{"name":"CoreDataStack","abstract":"

    An instance of CoreDataStack encapsulates the entire Core Data stack."},"getting-started.html":{"name":"Getting Started"},"Guides.html":{"name":"Guides","abstract":"

    The following guides are available globally.

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Global Variables.html":{"name":"Global Variables","abstract":"

    The following global variables are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Functions.html":{"name":"Functions","abstract":"

    The following functions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file +{"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV22PersistentStoreOptionsa":{"name":"PersistentStoreOptions","abstract":"

    Describes the initialization options for a persistent store.

    ","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV19defaultStoreOptionsSDys11AnyHashableVypGvpZ":{"name":"defaultStoreOptions","abstract":"

    Describes default persistent store options.

    ","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV5modelAA0dB5ModelVvp":{"name":"model","abstract":"

    The model for the stack that the factory produces.

    ","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV7optionsSDys11AnyHashableVypGSgvp":{"name":"options","abstract":"

    A dictionary that specifies options for the store that the factory produces.","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV5model7optionsAcA0dB5ModelV_SDys11AnyHashableVypGSgtcfc":{"name":"init(model:options:)","abstract":"

    Constructs a new CoreDataStackFactory instance with the specified model and options.

    ","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV06createE07onQueue10completionySo17OS_dispatch_queueCSg_yAA0E6ResultOctF":{"name":"createStack(onQueue:completion:)","abstract":"

    Initializes a new CoreDataStack instance using the factory’s model and options.

    ","parent_name":"CoreDataStackFactory"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV4nameSSvp":{"name":"name","abstract":"

    The name of the Core Data model resource.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV6bundleSo8NSBundleCvp":{"name":"bundle","abstract":"

    The bundle in which the model is located.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV9storeTypeAA05StoreG0Ovp":{"name":"storeType","abstract":"

    The type of the Core Data persistent store for the model.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV8storeURL10Foundation0G0VSgvp":{"name":"storeURL","abstract":"

    The file URL specifying the full path to the store.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV8modelURL10Foundation0G0Vvp":{"name":"modelURL","abstract":"

    The file URL specifying the model file in the bundle specified by bundle.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV16databaseFileNameSSvp":{"name":"databaseFileName","abstract":"

    The database file name for the store.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV013managedObjectE0So09NSManagedgE0Cvp":{"name":"managedObjectModel","abstract":"

    The managed object model for the model specified by name.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV14needsMigrationSbvp":{"name":"needsMigration","abstract":"

    Queries the meta data for the persistent store specified by the receiver","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV4name6bundle9storeTypeACSS_So8NSBundleCAA05StoreI0Otcfc":{"name":"init(name:bundle:storeType:)","abstract":"

    Constructs a new CoreDataModel instance with the specified name and bundle.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV19removeExistingStoreyyKF":{"name":"removeExistingStore()","abstract":"

    Removes the existing model store specfied by the receiver.

    ","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV19defaultDirectoryURL10Foundation0H0VyFZ":{"name":"defaultDirectoryURL()","abstract":"

    The default directory used to initialize a CoreDataModel.","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV7migrateyyKF":{"name":"migrate()","abstract":"

    Progressively migrates the persistent store of the CoreDataModel based on mapping models found in the model’s bundle.","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html":{"name":"CoreDataModel","abstract":"

    An instance of CoreDataModel represents a Core Data model — a .xcdatamodeld file package."},"Structs/CoreDataStackFactory.html":{"name":"CoreDataStackFactory","abstract":"

    An instance of CoreDataStackFactory is responsible for creating instances of CoreDataStack.

    "},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolP10entityNameSSvpZ":{"name":"entityName","abstract":"

    The name of the entity.

    ","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolP22defaultSortDescriptorsSaySo16NSSortDescriptorCGvpZ":{"name":"defaultSortDescriptors","abstract":"

    The default sort descriptors for a fetch request.

    ","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolPAASo15NSManagedObjectCRbzrlE12fetchRequestSo07NSFetchJ0CyxGvpZ":{"name":"fetchRequest","abstract":"

    Returns a new fetch request with defaultSortDescriptors.

    ","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolPAASo15NSManagedObjectCRbzrlE6entity7contextSo19NSEntityDescriptionCSo0gH7ContextC_tFZ":{"name":"entity(context:)","abstract":"

    Returns the entity with the specified name from the managed object model associated","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html":{"name":"CoreDataEntityProtocol","abstract":"

    Describes an entity in Core Data.

    "},"Extensions/NSManagedObjectContext.html#/s:So22NSManagedObjectContextC14JSQCoreDataKitE05ChildC0a":{"name":"ChildContext","abstract":"

    Describes a child managed object context.

    ","parent_name":"NSManagedObjectContext"},"Extensions/NSManagedObjectContext.html#/s:So22NSManagedObjectContextC14JSQCoreDataKitE4save4wait10completionySb_yAC10SaveResultOcSgtF":{"name":"save(wait:completion:)","abstract":"

    Attempts to commit unsaved changes to registered objects in the context.","parent_name":"NSManagedObjectContext"},"Extensions/NSManagedObjectContext.html":{"name":"NSManagedObjectContext"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO6sqliteyAC10Foundation3URLVcACmF":{"name":"sqlite(_:)","abstract":"

    The SQLite database store type. The associated file URL specifies the directory for the store.

    ","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO6binaryyAC10Foundation3URLVcACmF":{"name":"binary(_:)","abstract":"

    The binary store type. The associated file URL specifies the directory for the store.

    ","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO8inMemoryyA2CmF":{"name":"inMemory","abstract":"

    The in-memory store type.

    ","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO4typeSSvp":{"name":"type","abstract":"

    Returns the type string description for the store type.

    ","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO14storeDirectory10Foundation3URLVSgyF":{"name":"storeDirectory()","abstract":"
    ","parent_name":"StoreType"},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO7successyAcA04CorebD0CcACmF":{"name":"success(_:)","abstract":"

    The success result, containing the successfully initialized CoreDataStack.

    ","parent_name":"StackResult"},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO7failureyACSo7NSErrorCcACmF":{"name":"failure(_:)","abstract":"

    The failure result, containing an NSError instance that describes the error.

    ","parent_name":"StackResult"},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO5stackAA04CorebD0CSgyF":{"name":"stack()","parent_name":"StackResult"},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO5errorSo7NSErrorCSgyF":{"name":"error()","parent_name":"StackResult"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO7successyA2CmF":{"name":"success","abstract":"

    The success result.

    ","parent_name":"SaveResult"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO7failureyACSo7NSErrorCcACmF":{"name":"failure(_:)","abstract":"

    The failure result, containing an NSError instance that describes the error.

    ","parent_name":"SaveResult"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO5errorSo7NSErrorCSgyF":{"name":"error()","parent_name":"SaveResult"},"Enums/MigrationError.html#/s:14JSQCoreDataKit14MigrationErrorO19sourceModelNotFoundyAcA04CorebG0V_tcACmF":{"name":"sourceModelNotFound(model:)","abstract":"

    Specifies that the NSManagedObjectModel corresponding to the existing persistent store was not found in the model’s bundle.

    ","parent_name":"MigrationError"},"Enums/MigrationError.html#/s:14JSQCoreDataKit14MigrationErrorO20mappingModelNotFoundyACSo015NSManagedObjectG0C_tcACmF":{"name":"mappingModelNotFound(destinationModel:)","abstract":"

    Specifies that an NSMappingModel was not found in the model’s bundle in the progressive migration ‘path’.

    ","parent_name":"MigrationError"},"Enums/ModelFileExtension.html#/s:14JSQCoreDataKit18ModelFileExtensionO6bundleyA2CmF":{"name":"bundle","abstract":"

    The extension for a model bundle, or a .xcdatamodeld file package.

    ","parent_name":"ModelFileExtension"},"Enums/ModelFileExtension.html#/s:14JSQCoreDataKit18ModelFileExtensionO09versionedE0yA2CmF":{"name":"versionedFile","abstract":"

    The extension for a versioned model file, or a .xcdatamodel file.

    ","parent_name":"ModelFileExtension"},"Enums/ModelFileExtension.html#/s:14JSQCoreDataKit18ModelFileExtensionO7mappingyA2CmF":{"name":"mapping","abstract":"

    The extension for a mapping model file, or a .xcmappingmodel file.

    ","parent_name":"ModelFileExtension"},"Enums/ModelFileExtension.html#/s:14JSQCoreDataKit18ModelFileExtensionO6sqliteyA2CmF":{"name":"sqlite","abstract":"

    The extension for a sqlite store.

    ","parent_name":"ModelFileExtension"},"Enums/ModelFileExtension.html":{"name":"ModelFileExtension","abstract":"

    Describes a Core Data model file exention type based on the"},"Enums/MigrationError.html":{"name":"MigrationError","abstract":"

    An error type that specifies possible errors that are thrown by calling CoreDataModel.migrate() throws.

    "},"Enums/SaveResult.html":{"name":"SaveResult","abstract":"

    A result object representing the result of saving an NSManagedObjectContext.

    "},"Enums/StackResult.html":{"name":"StackResult","abstract":"

    A result object representing the result of creating a CoreDataStack via a CoreDataStackFactory.

    "},"Enums/StoreType.html":{"name":"StoreType","abstract":"

    Describes a Core Data persistent store type.

    "},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC5modelAA0dB5ModelVvp":{"name":"model","abstract":"

    The model for the stack.

    ","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC11mainContextSo015NSManagedObjectG0Cvp":{"name":"mainContext","abstract":"

    The main managed object context for the stack, which operates on the main queue.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC17backgroundContextSo015NSManagedObjectG0Cvp":{"name":"backgroundContext","abstract":"

    The background managed object context for the stack, which operates on a background queue.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC16storeCoordinatorSo017NSPersistentStoreG0Cvp":{"name":"storeCoordinator","abstract":"

    The persistent store coordinator for the stack. Both contexts are connected to this coordinator.

    ","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC12childContext15concurrencyType011mergePolicyI0So015NSManagedObjectG0CSo0lmg11ConcurrencyI0V_So07NSMergekI0VtF":{"name":"childContext(concurrencyType:mergePolicyType:)","abstract":"

    Creates a new child context with the specified concurrencyType and mergePolicyType.

    ","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC5reset7onQueue10completionySo17OS_dispatch_queueC_yAA0E6ResultOctF":{"name":"reset(onQueue:completion:)","abstract":"

    Resets the managed object contexts in the stack on their respective threads.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html":{"name":"CoreDataStack","abstract":"

    An instance of CoreDataStack encapsulates the entire Core Data stack."},"getting-started.html":{"name":"Getting Started"},"Guides.html":{"name":"Guides","abstract":"

    The following guides are available globally.

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Extensions.html":{"name":"Extensions","abstract":"

    The following extensions are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "}} \ No newline at end of file