tom/ts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update description

Browse Source
This commit is contained in:
Tom Elliott 2025-02-24 16:08:32 +13:00
parent 606b6e195a
commit 58a6b7a9f1
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
DESCRIPTION
View File

@ -1,11 +1,15 @@
Package: ts Package: ts
Title: Helper Functions for Writing Type-safe Functions for rserve-ts Title: Helper Functions for Writing Type-safe Functions for rserve-ts
Version: 0.1.0 Version: 0.1.0
Authors@R: Authors@R: c(
person("Tom", "Elliott", , "tom@inzight.co.nz", person("Tom", "Elliott", , "tom@inzight.co.nz",
role = c("aut", "cre"), role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-7815-6318")) comment = c(
Description: A set of helper functions for writing type safe functions for writing and compiling typescript functions for use with rserve-ts. 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 <https://www.npmjs.com/package/rserve-ts>, provides the necessary infrastructure to run these functions in a Typescript environment.
License: MIT + file LICENSE License: MIT + file LICENSE
Encoding: UTF-8 Encoding: UTF-8
Roxygen: list(markdown = TRUE) Roxygen: list(markdown = TRUE)

3
man/ts_function.Rd
View File

@ -13,6 +13,9 @@ ts_function(f, ..., result = ts_void())
\item{result}{return type (ignored if overloads are provided)} \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{ \description{
TS function definition TS function definition
} }