Module egithub_json

Description
Data Types
Function Index
Function Details

This module defines a behavior that needs to be implemented using a specific JSON encoding/decoding library.

This module defines the egithub_json behaviour.
Required callback functions: encode/1, decode/1.

Description

This module defines a behavior that needs to be implemented using a specific JSON encoding/decoding library. The module implementing the behavior that will be used is determined by this application's json configuration value.

Data Types

json()

json() = jiffy:jiffy_decode_result()

Function Index

decode/1	Decodes the JSON value as iodata() using the specified implementation module found in the `egithub` application `json` env variable.
encode/1	Encodes the json() value using the specified implementation module found in the `egithub` application `json` env variable.

Function Details

decode/1

decode(Map::iodata()) -> json()

Decodes the JSON value as iodata() using the specified implementation module found in the egithub application json env variable. The default implementation module is egithub_jiffy.

encode/1

encode(Map::json()) -> binary()

Encodes the json() value using the specified implementation module found in the egithub application json env variable. The default implementation module is egithub_jiffy.

Generated by EDoc