···
(** The type representing a complete JSON Feed. *)
+
(** Declarative type that describes the structure of JSON Feeds.
Maps the complete JSON Feed 1.1 specification including all required and
type t = (string * Jsont.json) list
+
(** Unknown or unrecognized JSON object members. Useful for preserving fields
from custom extensions or future spec versions. *)
···
(** [is_empty u] returns [true] if there are no unknown fields. *)
+
(** {1 Construction} *)
···
+
(** [create ~title ~items ()] creates a new JSON Feed.
+
The name of the feed. Required field that should be plain text, not HTML.
+
The URL of the resource that the feed describes. This resource may or may
+
not actually be a "home" page, but it should be an HTML page. If a feed is
+
for a podcast, for instance, the home_page_url would be the URL for the
+
The URL of the feed itself. This is the URL that was requested to get this
+
JSON Feed response. Helps feed readers to determine when they're being
+
redirected. Strongly recommended for feeds.
+
A plain text description of the feed, for human consumption. May contain
+
some formatting (like newlines).
+
A description of the purpose of the feed, for a person looking at the raw
+
JSON. This is for the publisher's use only, not intended to be displayed
+
The URL of a feed that provides the next n items, where n is determined by
+
the publisher. Used for pagination. A feed reader may continue to request
+
the URLs in next_url until it reaches a feed without a next_url.
+
The URL of an image for the feed suitable to be used in a timeline, much
+
the way an avatar might be used. Should be square and relatively large -
+
such as 512 x 512 pixels - and may be cropped to a circle or rounded
+
corners. Should not be transparent.
+
The URL of an image for the feed suitable to be used in a source list.
+
Should be square and relatively small - such as 64 x 64 pixels. Should not
+
Specifies one or more feed authors. The author object has several members
+
(name, url, avatar) which are all optional, but at least one must be
+
present for the object to be valid.
+
The primary language for the feed in RFC 5646 format. The value can be a
+
language tag such as "en" or "en-US", or a language-region combination.
+
Whether or not the feed is finished - that is, whether or not it will ever
+
update again. A feed for a temporary event, like an instance of a
+
conference, may expire. If the value is [true], feed readers may stop
+
Endpoints that can be used to subscribe to real-time notifications from
+
the publisher of this feed. Each hub object has a type (such as "rssCloud"
+
The items in the feed. Required field, though it may be an empty array.
+
Unknown JSON object members preserved from parsing. Useful for custom
val version : t -> string
+
(** [version feed] returns the URL of the version of the format the feed uses.
+
This will always be "https://jsonfeed.org/version/1.1" for feeds created
+
with this library. This is a required field in the JSON Feed spec. *)
+
(** [title feed] returns the name of the feed. This is plain text and should not
+
contain HTML. This is a required field. *)
val home_page_url : t -> string option
+
(** [home_page_url feed] returns the URL of the resource that the feed
+
describes. This resource may or may not actually be a "home" page, but it
+
should be an HTML page. For instance, if a feed is for a podcast, the
+
home_page_url would be the URL for the podcast's website. *)
val feed_url : t -> string option
+
(** [feed_url feed] returns the URL of the feed itself. This should be the URL
+
that was requested to get this JSON Feed response. It helps feed readers
+
determine when they're being redirected. This is strongly recommended for
val description : t -> string option
+
(** [description feed] returns a plain text description of the feed, for human
+
consumption. This field may contain some formatting such as newlines. *)
val user_comment : t -> string option
+
(** [user_comment feed] returns a description of the purpose of the feed, for a
+
person looking at the raw JSON. This is for the publisher's use only and is
+
not intended to be displayed to end users. *)
val next_url : t -> string option
+
(** [next_url feed] returns the URL of a feed that provides the next n items,
+
where n is determined by the publisher. This is used for pagination. A feed
+
reader may continue to request the URLs in next_url until it reaches a feed
val icon : t -> string option
+
(** [icon feed] returns the URL of an image for the feed suitable to be used in
+
a timeline, much the way an avatar might be used. It should be square and
+
relatively large (such as 512 x 512 pixels) and may be cropped to a circle
+
or rounded corners by feed readers. It should not be transparent. *)
val favicon : t -> string option
+
(** [favicon feed] returns the URL of an image for the feed suitable to be used
+
in a source list. It should be square and relatively small (such as 64 x 64
+
pixels) and should not be transparent. *)
val authors : t -> Author.t list option
+
(** [authors feed] returns the feed authors. Each author object has several
+
members (name, url, avatar) which are all optional, but at least one must be
+
present for the object to be valid. If a feed has multiple authors, they
+
should all be listed here. *)
val language : t -> string option
+
(** [language feed] returns the primary language for the feed in RFC 5646
+
format. The value can be a language tag such as "en" or "en-US", or a
+
language-region combination. This field helps feed readers present the feed
+
in the appropriate language. *)
val expired : t -> bool option
+
(** [expired feed] returns whether the feed is finished - that is, whether it
+
will ever update again. A feed for a temporary event, like an instance of a
+
conference, may expire. If the value is [Some true], feed readers may stop
+
checking for updates. *)
val hubs : t -> Hub.t list option
+
(** [hubs feed] returns endpoints that can be used to subscribe to real-time
+
notifications from the publisher of this feed. Each hub object has a type
+
(such as "rssCloud" or "WebSub") and a url. Feed readers can use these to
+
get immediate updates when new items are published. *)
val items : t -> Item.t list
+
(** [items feed] returns the array of items in the feed. This is a required
+
field, though it may be an empty list. Items represent the individual
+
entries in the feed - blog posts, podcast episodes, microblog posts, etc. *)
val unknown : t -> Unknown.t
+
(** [unknown feed] returns any unknown JSON object members that were preserved
+
during parsing. This is useful for custom extensions or fields from future
+
versions of the spec. *)
(** {1 Encoding and Decoding} *)
anil.recoil.org