JsPath

The names of the product elements

The name of the type

Reads/Writes a T at JsPath using provided explicit Writes[T] and implicit Reads[T]

Reads/Writes a T at JsPath using provided explicit Reads[T] and implicit Writes[T]

Reads/Writes a T at JsPath using provided implicit Format[T]

Reads/Writes a Option[T] (optional or nullable field) at given JsPath

Reads/Writes a Option[T] (nullable field) at given JsPath

Reads/Writes a T at JsPath using provided implicit Format[T] with fallback to default value

Lazy Reads/Writes a T at given JsPath using explicit Reads[T] and Writes[T] (useful in case of recursive case classes).

Lazy Reads/Writes a T at given JsPath using implicit Format[T] (useful in case of recursive case classes).

Lazy Reads/Writes a Option[T] (optional or nullable field) at given JsPath using explicit Reads[T] and Writes[T] (useful in case of recursive case classes).

Lazy Reads/Writes a Option[T] (optional or nullable field) at given JsPath using implicit Format[T] (useful in case of recursive case classes).

Reads a T at JsPath using the explicit Reads[T] passed by name which is useful in case of recursive case classes for ex.

import play.api.libs.functional.syntax._
import play.api.libs.json.{ Reads, __ }

case class User(id: Long, name: String, friend: User)

implicit lazy val UserReads: Reads[User] = (
 (__ \ 'id).read[Long] and
 (__ \ 'name).read[String] and
 (__ \ 'friend).lazyRead(UserReads)
)(User.apply _)

Reads lazily a Option[T] search optional or nullable field at JsPath using the explicit Reads[T] passed by name which is useful in case of recursive case classes for ex.

import play.api.libs.functional.syntax._
import play.api.libs.json.{ Reads, __ }

case class User(id: Long, name: String, friend: Option[User])

implicit lazy val UserReads: Reads[User] = (
 (__ \ 'id).read[Long] and
 (__ \ 'name).read[String] and
 (__ \ 'friend).lazyReadNullable(UserReads)
)(User.apply _)

Writes a T at JsPath using the explicit Writes[T] passed by name which is useful in case of recursive case classes for ex

import play.api.libs.functional.syntax._
import play.api.libs.json.{ Writes, __ }

case class User(id: Long, name: String, friend: User)

implicit lazy val UserWrites: Writes[User] = (
 (__ \ 'id).write[Long] and
 (__ \ 'name).write[String] and
 (__ \ 'friend).lazyWrite(UserWrites)
)(unlift(User.unapply))

Writes a Option[T] at JsPath using the explicit Writes[T] passed by name which is useful in case of recursive case classes for ex

Please note that it's not writeOpt to be coherent with readNullable

import play.api.libs.functional.syntax._
import play.api.libs.json.{ Writes, __ }

case class User(id: Long, name: String, friend: Option[User])

implicit lazy val UserWrites: Writes[User] = (
 (__ \ 'id).write[Long] and
 (__ \ 'name).write[String] and
 (__ \ 'friend).lazyWriteNullable(UserWrites)
)(unlift(User.unapply))

Simple Prune for simple path and only JsObject

Pure Reads doesn't read anything but creates a JsObject based on JsPath with the given T value

Reads a T at JsPath

Reads a Option[T] search optional or nullable field at JsPath (field not found or null is None and other cases are Error).

It runs through JsValue following all JsPath nodes on JsValue:

• If any node in JsPath is not found => returns None
• If any node in JsPath is found with value "null" => returns None
• If the entire path is found => applies implicit Reads[T]

Reads an Option[T] search optional or nullable field at JsPath (field not found replaced by default value, null is None and other cases are Error).

It runs through JsValue following all JsPath nodes on JsValue except last node:

• If any node in JsPath is not found => returns default value
• If any node in JsPath is found with value "null" => returns None
• If the entire path is found => applies implicit Reads[T]

Reads a T at JsPath

Reads/Writes a T at JsPath using provided implicit Reads[T] and Writes[T]

Please note we couldn't call it "format" to prevent conflicts

Writes a pure value at given JsPath

Writes a T at given JsPath

Writes a Option[T] at given JsPath If None => doesn't write the field (never writes null actually) else => writes the field using implicit Writes[T]

Writes a Option[T] at given JsPath If None => writes 'null' else => writes the field using implicit Writes[T]