https://github.com/yume190/jsondecodekit

A Light weight JSON Mapper
https://github.com/yume190/jsondecodekit

carthage cocoapods ios json mac swift

Last synced: about 1 month ago
JSON representation

A Light weight JSON Mapper

• Host: GitHub
• URL: https://github.com/yume190/jsondecodekit
• Owner: yume190
• License: mit
• Created: 2016-11-03T05:39:42.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2019-06-21T07:58:52.000Z (over 5 years ago)
• Last Synced: 2024-12-22T18:46:45.582Z (about 1 month ago)
• Topics: carthage, cocoapods, ios, json, mac, swift
• Language: Swift
• Homepage:
• Size: 772 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
JSONDecodeKit

==========

[![Build Status](https://travis-ci.org/yume190/JSONDecodeKit.svg?branch=master)](https://travis-ci.org/yume190/JSONDecodeKit)

[![codecov](https://codecov.io/gh/yume190/JSONDecodeKit/branch/master/graph/badge.svg)](https://codecov.io/gh/yume190/JSONDecodeKit)

[![codebeat badge](https://codebeat.co/badges/8a9cacec-df7b-4e25-8134-25bcc5eeb345)](https://codebeat.co/projects/github-com-yume190-jsondecodekit-master)

A light weight JSON Mapper.

Inspired by some JSON libraries :

 * [Argo](https://github.com/thoughtbot/Argo)

 * [Himotoki](https://github.com/ikesyo/Himotoki)

 * [Marshal](https://github.com/utahiosmac/Marshal)

According to [JSONShootout](https://github.com/bwhiteley/JSONShootout), we testing the json mapping speed, and we have same performance with Marshal.

## Usage

```swift

struct Sample:JSONDecodable {

    let temp:Int

    static func decode(_ dic: JSON) throws -> Sample {

        return try Sample(temp: dic <| "temp")

    }

}

let json = JSON(any: ["temp":1234])

let sample:Sample? = try? Sample.decode(json)

```

---

## Protocols

#### PrimitiveType 

PrimitiveType focus on casting type and transform from string 

 * Casting Type

```swift

return self as? T

// return 1 as? Int

// return "1" as? Int

```

 * Transform From String (`String -> T`)

```swift

return Int("1")     // "1" -> 1

return Int("true")  // "true" -> true

```

 * Support Types

```swift

Int     Int8    Int16   Int32   Int64

UInt    UInt8   UInt16  UInt32  UInt64

Float   Double

Bool

String

```

#### JSONDecodable

JSONDecodable is the protocol, mapping `JSON` to your customize struct.

---

#### Operators

|Operator|Decode element|

|:------:|:------------:|

| `<\|?`  | `T?` |

| `<\|`   | `T` |

| `<\|\|`  | `[T]` |