Skip to content

Commit

Permalink
docs: add link to generated API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dancrumb committed Jul 30, 2024
1 parent 9a974a4 commit 2fe659c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# FP-ish

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdancrumb%2Ffpish.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdancrumb%2Ffpish?ref=badge_shield)
[![Build Status](https://img.shields.io/github/actions/workflow/status/dancrumb/fpish/build-and-test.yml?branch=main)](https://github.com/dancrumb/fpish/actions/workflows/build-and-test.yml)
[![Known Vulnerabilities](https://snyk.io/test/github/dancrumb/fpish/badge.svg)](https://snyk.io/test/github/dancrumb/fpish)

This package contains a series of "FP-friendly" classes for use in your code.

## API Documentation

See https://dancrumb.com/fpish/

## What is "FP-friendly"?

An “FP-friendly’ object can be defined as an instance of the class with immutable internal property and a set of methods that are all ‘pure’ with the caveat that they are able to read internal fields without treating that as a side effect?
Expand Down
6 changes: 4 additions & 2 deletions src/AsyncData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ export enum RemoteDataStatus {

/**
* This class represents data from a remote source that takes time to load.
*
* This data can be a single value or an array of values. Since there's no way to
* infer the shape of the data, the caller is expected to know and to make the
* appropriate calls
*
* It can be single-valued or an array of values. The caller is expected to
* know which it is
*
* @template D A type representing the shape of data that is being requested
* @template E A type representing the shape of errors that can be returned
Expand Down

0 comments on commit 2fe659c

Please sign in to comment.