From 58a6b7a9f1f9a1db6edbe67e2a44fc204eabdfe1 Mon Sep 17 00:00:00 2001 From: Tom Elliott Date: Mon, 24 Feb 2025 16:08:32 +1300 Subject: [PATCH] update description --- DESCRIPTION | 10 +++++++--- man/ts_function.Rd | 3 +++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 1ee28e8..3e45e35 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,11 +1,15 @@ Package: ts Title: Helper Functions for Writing Type-safe Functions for rserve-ts Version: 0.1.0 -Authors@R: +Authors@R: c( person("Tom", "Elliott", , "tom@inzight.co.nz", role = c("aut", "cre"), - comment = c(ORCID = "0000-0002-7815-6318")) -Description: A set of helper functions for writing type safe functions for writing and compiling typescript functions for use with rserve-ts. + comment = c( + ORCID = "0000-0002-7815-6318", + Funding = "Supported by the Ngā Puanga Pūtaiao Fellowships from Government funding, administered by the Royal Society Te Apārangi, New Zealand." + )) + ) +Description: A set of helper functions for specifying typed functions for writing and compiling TypesSript functions for use with rserve-ts. The package allows users to easily specify Javascript input types and Rserve output types for Ocap (object capability) functioned. The companion library 'rserve-ts', available on npm , provides the necessary infrastructure to run these functions in a Typescript environment. License: MIT + file LICENSE Encoding: UTF-8 Roxygen: list(markdown = TRUE) diff --git a/man/ts_function.Rd b/man/ts_function.Rd index c76e353..70b944a 100644 --- a/man/ts_function.Rd +++ b/man/ts_function.Rd @@ -13,6 +13,9 @@ ts_function(f, ..., result = ts_void()) \item{result}{return type (ignored if overloads are provided)} } +\value{ +a ts function object which has a \code{call} method that will call the function with the given arguments, which will be checked for type correctness. +} \description{ TS function definition }