SBJsonWriter

@protocol SBJsonWriter

@brief Options for the writer class.

This exists so the SBJSON facade can implement the options in the writer without having to re-declare them.

  • @brief Whether we are generating human-readable (multiline) JSON.

    Set whether or not to generate human-readable JSON. The default is NO, which produces JSON without any whitespace. (Except inside strings.) If set to YES, generates human-readable JSON with linebreaks after each array value and dictionary key/value pair, indented two spaces per nesting level.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) BOOL humanReadable;

    Swift

    var humanReadable: Bool { get set }

  • @brief Whether or not to sort the dictionary keys in the output.

    If this is set to YES, the dictionary keys in the JSON output will be in sorted order. (This is useful if you need to compare two structures, for example.) The default is NO.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) BOOL sortKeys;

    Swift

    var sortKeys: Bool { get set }

  • @brief Return JSON representation (or fragment) for the given object.

    Returns a string containing JSON representation of the passed in value, or nil on error. If nil is returned and @p error is not NULL, @p *error can be interrogated to find the cause of the error.

    Declaration

    Objective-C

    - (NSString *)stringWithObject:(id)value;

    Swift

    func string(with value: Any!) -> String!

    Parameters

    value

    any instance that can be represented as a JSON fragment