R/is_.R

Defines functions is_dispatcher is_handler is_handlers_list is_event_list is_event

Documented in is_dispatcher is_event is_event_list is_handler is_handlers_list

#' @title Is an Object from a class?
#'
#' @description Test if an object is some of the classes implemented in `eventr` package.
#'
#' @param x any `R` object.
#'
#' @return Returns a logical value
#'
#' @examples
#'
#' birth_event <- event(
#'   id = 'first-id',
#'   type = 'BIRTH',
#'   time = '1936-11-09',
#'   birth_date = '1936-11-09'
#' )
#'
#' is_event(birth_event)
#'
#' @export
is_event <- function(x) inherits(x, 'event')

#' @rdname is_event
#' @export
is_event_list <- function(x) inherits(x, 'event_list')

#' @rdname is_event
#' @export
is_handlers_list <- function(x) inherits(x, 'handlers_list')

#' @rdname is_event
#' @export
is_handler <- function(x) inherits(x, 'handler')

#' @rdname is_event
#' @export
is_dispatcher <- function(x) inherits(x, 'dispatcher')

Try the eventr package in your browser

Any scripts or data that you put into this service are public.

eventr documentation built on July 8, 2020, 7:32 p.m.