Function nullable

nullable<T>(decoder: Decoder<T>): Decoder<null | T>

Decoder that accepts null values.

Type Parameters

T

Parameters

decoder: Decoder<T>
The decoder for the non-null value

Returns Decoder<null | T>

A decoder that accepts either the decoded value or null

Example

interface User {
  name: string;
  age: number | null;
}

const userDecoder = JsonDecoder.object<User>(
  {
    name: JsonDecoder.string(),
    age: JsonDecoder.nullable(JsonDecoder.number())
  },
  'User'
);

userDecoder.decode({name: 'John', age: null}); // Ok<User>
userDecoder.decode({name: 'John', age: 30}); // Ok<User>