Skip to content

Commit 84354eb

Browse files
📚 docs: Update.
1 parent a9b1f2f commit 84354eb

File tree

7 files changed

+45
-72
lines changed

7 files changed

+45
-72
lines changed

.esdoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"autoPrivate": true
1414
},
1515
"brand": {
16-
"title": "@aureooms/js-type"
16+
"title": "@functional-abstraction/type"
1717
},
1818
"test": {
1919
"type": "ava",

README.md

Lines changed: 30 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1-
[@aureooms/js-type](https://make-github-pseudonymous-again.github.io/js-type)
1+
[@functional-abstraction/type](https://functional-abstraction.github.io/type)
22
==
33

4-
Type checking code bricks for JavaScript.
4+
Type helpers for JavaScript.
55

66
```js
7-
type.isfunction( function ( ) { } ) ; // true
7+
import {isFunction} from '@functional-abstraction/type';
8+
isFunction(() => {}); // true
89
```
910

10-
[![License](https://img.shields.io/github/license/make-github-pseudonymous-again/js-type.svg)](https://raw.githubusercontent.com/make-github-pseudonymous-again/js-type/main/LICENSE)
11-
[![Version](https://img.shields.io/npm/v/@aureooms/js-type.svg)](https://www.npmjs.org/package/@aureooms/js-type)
12-
[![Tests](https://img.shields.io/github/workflow/status/make-github-pseudonymous-again/js-type/ci:cover?event=push&label=tests)](https://github.com/make-github-pseudonymous-again/js-type/actions/workflows/ci:cover.yml?query=branch:main)
13-
[![Dependencies](https://img.shields.io/librariesio/github/make-github-pseudonymous-again/js-type.svg)](https://github.com/make-github-pseudonymous-again/js-type/network/dependencies)
14-
[![GitHub issues](https://img.shields.io/github/issues/make-github-pseudonymous-again/js-type.svg)](https://github.com/make-github-pseudonymous-again/js-type/issues)
15-
[![Downloads](https://img.shields.io/npm/dm/@aureooms/js-type.svg)](https://www.npmjs.org/package/@aureooms/js-type)
11+
[![License](https://img.shields.io/github/license/functional-abstraction/type.svg)](https://raw.githubusercontent.com/functional-abstraction/type/main/LICENSE)
12+
[![Version](https://img.shields.io/npm/v/@functional-abstraction/type.svg)](https://www.npmjs.org/package/@functional-abstraction/type)
13+
[![Tests](https://img.shields.io/github/workflow/status/functional-abstraction/type/ci:cover?event=push&label=tests)](https://github.com/functional-abstraction/type/actions/workflows/ci:cover.yml?query=branch:main)
14+
[![Dependencies](https://img.shields.io/librariesio/github/functional-abstraction/type.svg)](https://github.com/functional-abstraction/type/network/dependencies)
15+
[![GitHub issues](https://img.shields.io/github/issues/functional-abstraction/type.svg)](https://github.com/functional-abstraction/type/issues)
16+
[![Downloads](https://img.shields.io/npm/dm/@functional-abstraction/type.svg)](https://www.npmjs.org/package/@functional-abstraction/type)
1617

17-
[![Code issues](https://img.shields.io/codeclimate/issues/make-github-pseudonymous-again/js-type.svg)](https://codeclimate.com/github/make-github-pseudonymous-again/js-type/issues)
18-
[![Code maintainability](https://img.shields.io/codeclimate/maintainability/make-github-pseudonymous-again/js-type.svg)](https://codeclimate.com/github/make-github-pseudonymous-again/js-type/trends/churn)
19-
[![Code coverage (cov)](https://img.shields.io/codecov/c/gh/make-github-pseudonymous-again/js-type/main.svg)](https://codecov.io/gh/make-github-pseudonymous-again/js-type)
20-
[![Code technical debt](https://img.shields.io/codeclimate/tech-debt/make-github-pseudonymous-again/js-type.svg)](https://codeclimate.com/github/make-github-pseudonymous-again/js-type/trends/technical_debt)
21-
[![Documentation](https://make-github-pseudonymous-again.github.io/js-type//badge.svg)](https://make-github-pseudonymous-again.github.io/js-type//source.html)
22-
[![Package size](https://img.shields.io/bundlephobia/minzip/@aureooms/js-type)](https://bundlephobia.com/result?p=@aureooms/js-type)
18+
[![Code issues](https://img.shields.io/codeclimate/issues/functional-abstraction/type.svg)](https://codeclimate.com/github/functional-abstraction/type/issues)
19+
[![Code maintainability](https://img.shields.io/codeclimate/maintainability/functional-abstraction/type.svg)](https://codeclimate.com/github/functional-abstraction/type/trends/churn)
20+
[![Code coverage (cov)](https://img.shields.io/codecov/c/gh/functional-abstraction/type/main.svg)](https://codecov.io/gh/functional-abstraction/type)
21+
[![Code technical debt](https://img.shields.io/codeclimate/tech-debt/functional-abstraction/type.svg)](https://codeclimate.com/github/functional-abstraction/type/trends/technical_debt)
22+
[![Documentation](https://functional-abstraction.github.io/type/badge.svg)](https://functional-abstraction.github.io/type/source.html)
23+
[![Package size](https://img.shields.io/bundlephobia/minzip/@functional-abstraction/type)](https://bundlephobia.com/result?p=@functional-abstraction/type)
2324

2425
Can be managed through [jspm](https://github.com/jspm/jspm-cli),
2526
[duo](https://github.com/duojs/duo),
@@ -34,96 +35,68 @@ and [npm](https://github.com/npm/npm).
3435

3536
### jspm
3637
```terminal
37-
jspm install github:aureooms/js-type
38+
jspm install github:functional-abstraction/type
3839
# or
39-
jspm install npm:@aureooms/js-type
40+
jspm install npm:@functional-abstraction/type
4041
```
4142
### duo
4243
No install step needed for duo!
4344

4445
### component
4546
```terminal
46-
component install aureooms/js-type
47+
component install functional-abstraction/type
4748
```
4849

4950
### bower
5051
```terminal
51-
bower install @aureooms/js-type
52+
bower install @functional-abstraction/type
5253
```
5354

5455
### ender
5556
```terminal
56-
ender add @aureooms/js-type
57+
ender add @functional-abstraction/type
5758
```
5859

5960
### jam
6061
```terminal
61-
jam install @aureooms/js-type
62+
jam install @functional-abstraction/type
6263
```
6364

6465
### spm
6566
```terminal
66-
spm install @aureooms/js-type --save
67+
spm install @functional-abstraction/type --save
6768
```
6869

6970
### npm
7071
```terminal
71-
npm install @aureooms/js-type --save
72+
npm install @functional-abstraction/type --save
7273
```
7374

7475
## Require
7576
### jspm
7677
```js
77-
let type = require( "github:aureooms/js-type" ) ;
78+
let type = require( "github:functional-abstraction/type" ) ;
7879
// or
79-
import type from '@aureooms/js-type' ;
80+
import type from '@functional-abstraction/type' ;
8081
```
8182
### duo
8283
```js
83-
let type = require( "aureooms/js-type" ) ;
84+
let type = require( "functional-abstraction/type" ) ;
8485
```
8586

8687
### component, ender, spm, npm
8788
```js
88-
let type = require( "@aureooms/js-type" ) ;
89+
let type = require( "@functional-abstraction/type" ) ;
8990
```
9091

9192
### bower
9293
The script tag exposes the global variable `type`.
9394
```html
94-
<script src="bower_components/@aureooms/js-type/js/dist/type.min.js"></script>
95+
<script src="bower_components/@functional-abstraction/type/js/dist/type.min.js"></script>
9596
```
9697
Alternatively, you can use any tool mentioned [here](http://bower.io/docs/tools/).
9798

9899
### jam
99100
```js
100-
require( [ "@aureooms/js-type" ] , function ( type ) { ... } ) ;
101+
require( [ "@functional-abstraction/type" ] , function ( type ) { ... } ) ;
101102
```
102-
103-
## Use
104-
105-
### Generic methods
106-
107-
#### `type.isinstance( object )`
108-
#### `type.isnull( object )`
109-
#### `type.isundefined( object )`
110-
111-
### Methods for numbers
112-
113-
#### `type.isfinite( object )`
114-
#### `type.isint32( object )`
115-
#### `type.isint( object )`
116-
#### `type.isnan( object )`
117-
#### `type.isnegativeinfinity( object )`
118-
#### `type.isnumber( object )`
119-
#### `type.ispositiveinfinity( object )`
120-
121-
### Methods for objects
122-
123-
#### `type.isarray( object )`
124-
#### `type.isboolean( object )`
125-
#### `type.isdate( object )`
126-
#### `type.isfunction( object )`
127-
#### `type.isobject( object )`
128-
#### `type.isregexp( object )`
129-
#### `type.isstring( object )`

doc/manual/example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Examples
22

3-
> More examples in [the test files](https://github.com/make-github-pseudonymous-again/js-type/tree/main/test/src).
3+
> More examples in [the test files](https://github.com/functional-abstraction/type/tree/main/test/src).

doc/manual/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ or [jspm](https://jspm.org/docs).
88

99
### yarn
1010
```terminal
11-
yarn add @aureooms/js-type
11+
yarn add @functional-abstraction/type
1212
```
1313

1414
### npm
1515
```terminal
16-
npm install @aureooms/js-type --save
16+
npm install @functional-abstraction/type --save
1717
```
1818

1919
### jspm
2020
```terminal
21-
jspm install npm:@aureooms/js-type
21+
jspm install npm:@functional-abstraction/type
2222
```

doc/manual/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import 'regenerator-runtime/runtime.js';
1313

1414
Then, import the library where needed
1515
```js
16-
const type = await import('@aureooms/js-type');
16+
const type = await import('@functional-abstraction/type');
1717
// or
18-
import * as type from '@aureooms/js-type';
18+
import * as type from '@functional-abstraction/type';
1919
```

doc/scripts/header.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ const domReady = function (callback) {
1010
domReady(() => {
1111
const projectname = document.createElement('a');
1212
projectname.classList.add('project-name');
13-
projectname.text = 'make-github-pseudonymous-again/js-type';
13+
projectname.text = 'functional-abstraction/type';
1414
projectname.href = './index.html';
1515

1616
const header = document.querySelector('header');
1717
header.insertBefore(projectname, header.firstChild);
1818

1919
const testlink = document.querySelector('header > a[data-ice="testLink"]');
20-
testlink.href = 'https://app.codecov.io/gh/make-github-pseudonymous-again/js-type';
20+
testlink.href = 'https://app.codecov.io/gh/functional-abstraction/type';
2121
testlink.target = '_BLANK';
2222

2323
const searchBox = document.querySelector('.search-box');

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "@aureooms/js-type",
3-
"description": "type checking code bricks for JavaScript",
2+
"name": "@functional-abstraction/type",
3+
"description": "Type helpers for JavaScript",
44
"version": "1.0.4",
5-
"author": "aureooms",
5+
"author": "make-github-pseudonymous-again",
66
"ava": {
77
"files": [
88
"test/src/**/*"
@@ -100,7 +100,7 @@
100100
}
101101
},
102102
"bugs": {
103-
"url": "https://github.com/make-github-pseudonymous-again/js-type/issues"
103+
"url": "https://github.com/functional-abstraction/type/issues"
104104
},
105105
"dependencies": {},
106106
"devDependencies": {
@@ -137,7 +137,7 @@
137137
"files": [
138138
"dist"
139139
],
140-
"homepage": "http://make-github-pseudonymous-again.github.io/js-type/",
140+
"homepage": "http://functional-abstraction.github.io/type",
141141
"keywords": [
142142
"bricks",
143143
"javascript",
@@ -151,7 +151,7 @@
151151
"module": "dist/index.module.mjs",
152152
"repository": {
153153
"type": "git",
154-
"url": "https://github.com/make-github-pseudonymous-again/js-type.git"
154+
"url": "https://github.com/functional-abstraction/type.git"
155155
},
156156
"scripts": {
157157
"build": "NODE_ENV=production microbundle",

0 commit comments

Comments
 (0)