JSON

public struct JSON

Undocumented


                    
                    
                    init(data:options:)

Creates a JSON using the data.

Declaration

Swift

public init(data: Data, options opt: JSONSerialization.ReadingOptions = []) throws

Parameters

`data`	The NSData used to convert to json.Top level object in data is an NSArray or NSDictionary
`opt`	The JSON serialization reading options. `[]` by default.

Return Value

The created JSON


                    
                    
                    init(_:)

Creates a JSON object

Note

this does not parse a String into JSON, instead use init(parseJSON: String)

Declaration

Swift

public init(_ object: Any)

Parameters


                                object

the object

Return Value

the created JSON object


                    
                    
                    init(parseJSON:)

Parses the JSON string into a JSON object

Declaration

Swift

public init(parseJSON jsonString: String)

Parameters


                                json

the JSON string

Return Value

the created JSON object


                    
                    
                    parse(_:)

Creates a JSON from JSON string

Declaration

Swift

public static func parse(_ json: String) -> JSON

Parameters


                                string

Normal json string like ‘{a:b}’

Return Value

The created JSON


                    
                    
                    merge(with:)

Merges another JSON into this JSON, whereas primitive values which are not present in this JSON are getting added, present values getting overwritten, array values getting appended and nested JSONs getting merged the same way.

Throws

throws ErrorWrongType if the other JSONs differs in type on the top level.

Declaration

Swift

public mutating func merge(with other: JSON) throws

Parameters


                                other

The JSON which gets merged into this JSON


                    
                    
                    merged(with:)

Merges another JSON into this JSON and returns a new JSON, whereas primitive values which are not present in this JSON are getting added, present values getting overwritten, array values getting appended and nested JSONS getting merged the same way.

Throws

throws ErrorWrongType if the other JSONs differs in type on the top level.

Declaration

Swift

public func merged(with other: JSON) throws -> JSON

Parameters


                                other

The JSON which gets merged into this JSON

Return Value

New merged JSON


                    
                    
                    type

JSON type, fileprivate setter

Declaration

Swift

public fileprivate(set) var type: Type = .null


                    
                    
                    error

Error in JSON, fileprivate setter

Declaration

Swift

public fileprivate(set) var error: SwiftyJSONError?

object
Object in JSON
Declaration
Swift

public var object: Any
null
Undocumented
Declaration
Swift

public static var null: JSON

startIndex
Declaration
Swift

public var startIndex: Index
endIndex
Declaration
Swift

public var endIndex: Index


                    
                    
                    index(after:)

Declaration

Swift

public func index(after i: Index) -> Index


                    
                    
                    subscript(_:)

Find a json in the complex data structures by using array of Int and/or String as path.

let json = JSON[data] let path = [9,list,person,name] let name = json[path]

The same as: let name = json[9][list][person][name]

Declaration

Swift

public subscript(path: [JSONSubscriptType]) -> JSON

Parameters


                                path

The target json’s path. Example:

Return Value

Return a json found by the path or a null json with error


                    
                    
                    subscript(_:)

Find a json in the complex data structures by using array of Int and/or String as path.

let name = json[9,list,person,name]

The same as: let name = json[9][list][person][name]

Declaration

Swift

public subscript(path: JSONSubscriptType...) -> JSON

Parameters


                                path

The target json’s path. Example:

Return Value

Return a json found by the path or a null json with error


                    
                    
                    init(stringLiteral:)

Declaration

Swift

public init(stringLiteral value: StringLiteralType)


                    
                    
                    init(extendedGraphemeClusterLiteral:)

Declaration

Swift

public init(extendedGraphemeClusterLiteral value: StringLiteralType)


                    
                    
                    init(unicodeScalarLiteral:)

Declaration

Swift

public init(unicodeScalarLiteral value: StringLiteralType)


                    
                    
                    init(integerLiteral:)

Declaration

Swift

public init(integerLiteral value: IntegerLiteralType)


                    
                    
                    init(booleanLiteral:)

Declaration

Swift

public init(booleanLiteral value: BooleanLiteralType)


                    
                    
                    init(floatLiteral:)

Declaration

Swift

public init(floatLiteral value: FloatLiteralType)


                    
                    
                    init(dictionaryLiteral:)

Declaration

Swift

public init(dictionaryLiteral elements: (String, Any)...)


                    
                    
                    init(arrayLiteral:)

Declaration

Swift

public init(arrayLiteral elements: Any...)

init(nilLiteral:)
Declaration
Swift

public init(nilLiteral: ())

init(rawValue:)
Declaration
Swift

public init?(rawValue: Any)
rawValue
Declaration
Swift

public var rawValue: Any


                    
                    
                    rawData(options:)

Undocumented

Declaration

Swift

public func rawData(options opt: JSONSerialization.WritingOptions = JSONSerialization.WritingOptions(rawValue: 0)) throws -> Data


                    
                    
                    rawString(_:options:)

Undocumented

Declaration

Swift

public func rawString(_ encoding: String.Encoding = .utf8, options opt: JSONSerialization.WritingOptions = .prettyPrinted) -> String?


                    
                    
                    rawString(_:)

Undocumented

Declaration

Swift

public func rawString(_ options: [writingOptionsKeys: Any]) -> String?

description
Declaration
Swift

public var description: String
debugDescription
Declaration
Swift

public var debugDescription: String

array
Undocumented
Declaration
Swift

public var array: [JSON]?
arrayValue
Undocumented
Declaration
Swift

public var arrayValue: [JSON]
arrayObject
Undocumented
Declaration
Swift

public var arrayObject: [Any]?

dictionary
Undocumented
Declaration
Swift

public var dictionary: [String : JSON]?


                    
                    
                    dictionaryValue

Undocumented

Declaration

Swift

public var dictionaryValue: [String : JSON]


                    
                    
                    dictionaryObject

Undocumented

Declaration

Swift

public var dictionaryObject: [String : Any]?

bool
Undocumented
Declaration
Swift

public var bool: Bool?
boolValue
Undocumented
Declaration
Swift

public var boolValue: Bool

string
Undocumented
Declaration
Swift

public var string: String?
stringValue
Undocumented
Declaration
Swift

public var stringValue: String

number
Undocumented
Declaration
Swift

public var number: NSNumber?
numberValue
Undocumented
Declaration
Swift

public var numberValue: NSNumber

null
Undocumented
Declaration
Swift

public var null: NSNull?
exists()
Undocumented
Declaration
Swift

public func exists() -> Bool

url
Undocumented
Declaration
Swift

public var url: URL?

double
Undocumented
Declaration
Swift

public var double: Double?
doubleValue
Undocumented
Declaration
Swift

public var doubleValue: Double
float
Undocumented
Declaration
Swift

public var float: Float?
floatValue
Undocumented
Declaration
Swift

public var floatValue: Float
int
Undocumented
Declaration
Swift

public var int: Int?
intValue
Undocumented
Declaration
Swift

public var intValue: Int
uInt
Undocumented
Declaration
Swift

public var uInt: UInt?
uIntValue
Undocumented
Declaration
Swift

public var uIntValue: UInt
int8
Undocumented
Declaration
Swift

public var int8: Int8?
int8Value
Undocumented
Declaration
Swift

public var int8Value: Int8
uInt8
Undocumented
Declaration
Swift

public var uInt8: UInt8?
uInt8Value
Undocumented
Declaration
Swift

public var uInt8Value: UInt8
int16
Undocumented
Declaration
Swift

public var int16: Int16?
int16Value
Undocumented
Declaration
Swift

public var int16Value: Int16
uInt16
Undocumented
Declaration
Swift

public var uInt16: UInt16?
uInt16Value
Undocumented
Declaration
Swift

public var uInt16Value: UInt16
int32
Undocumented
Declaration
Swift

public var int32: Int32?
int32Value
Undocumented
Declaration
Swift

public var int32Value: Int32
uInt32
Undocumented
Declaration
Swift

public var uInt32: UInt32?
uInt32Value
Undocumented
Declaration
Swift

public var uInt32Value: UInt32
int64
Undocumented
Declaration
Swift

public var int64: Int64?
int64Value
Undocumented
Declaration
Swift

public var int64Value: Int64
uInt64
Undocumented
Declaration
Swift

public var uInt64: UInt64?
uInt64Value
Undocumented
Declaration
Swift

public var uInt64Value: UInt64