Skip to content

Commit 56941b8

Browse files
committed
Fix JSDoc for Integer
Remove information about deprecated `Integer#from*()` functions. Mention exported functions. Fixes #293
1 parent bf34d90 commit 56941b8

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/v1/integer.js

+5-2
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,14 @@
2121
// https://github.com/dcodeIO/Long.js
2222
// License Apache 2
2323

24-
import {newError} from "./error";
24+
import {newError} from './error';
2525

2626
/**
2727
* Constructs a 64 bit two's-complement integer, given its low and high 32 bit values as *signed* integers.
28-
* See the from* functions below for more convenient ways of constructing Integers.
28+
* See exported functions for more convenient ways of operating integers.
29+
* Use <code>int()</code> function to create new integers, <code>isInt()</code> to check if given object is integer,
30+
* <code>inSafeRange()</code> to check if it is safe to convert given value to native number,
31+
* <code>toNumber()</code> and <code>toString()</code> to convert given integer to number or string respectively.
2932
* @access public
3033
* @exports Integer
3134
* @class A Integer class for representing a 64 bit two's-complement integer value.

0 commit comments

Comments
 (0)