Skip to content

Commit 2fe659c

Browse files
committed
docs: add link to generated API docs
1 parent 9a974a4 commit 2fe659c

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# FP-ish
2+
23
[![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)
34
[![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)
45
[![Known Vulnerabilities](https://snyk.io/test/github/dancrumb/fpish/badge.svg)](https://snyk.io/test/github/dancrumb/fpish)
56

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

9+
## API Documentation
10+
11+
See https://dancrumb.com/fpish/
12+
813
## What is "FP-friendly"?
914

1015
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?

src/AsyncData.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ export enum RemoteDataStatus {
2222

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

0 commit comments

Comments
 (0)