@rnacanvas/search 1.3.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,8 +11,38 @@ npm install @rnacanvas/search
|
|
|
11
11
|
All exports of this package can be accessed as named imports.
|
|
12
12
|
|
|
13
13
|
```javascript
|
|
14
|
-
//
|
|
15
|
-
import { SequenceCharacter } from '@rnacanvas/search';
|
|
14
|
+
// some example imports
|
|
15
|
+
import { Motif, SequenceCharacter } from '@rnacanvas/search';
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## `class Motif`
|
|
19
|
+
|
|
20
|
+
Represents a motif.
|
|
21
|
+
|
|
22
|
+
```javascript
|
|
23
|
+
var CUGCCA = new Motif('CUGCCA');
|
|
24
|
+
|
|
25
|
+
CUGCCA.toString(); // "CUGCCA"
|
|
26
|
+
|
|
27
|
+
// a single character motif
|
|
28
|
+
var A = new Motif('A');
|
|
29
|
+
|
|
30
|
+
A.toString(); // "A"
|
|
31
|
+
|
|
32
|
+
// empty motifs are accepted
|
|
33
|
+
var emptyMotif = new Motif('');
|
|
34
|
+
|
|
35
|
+
emptyMotif.toString(); // ""
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### `toString()`
|
|
39
|
+
|
|
40
|
+
Returns the motif as a string.
|
|
41
|
+
|
|
42
|
+
```javascript
|
|
43
|
+
var CUGCCA = new Motif('CUGCCA');
|
|
44
|
+
|
|
45
|
+
CUGCCA.toString(); // "CUGCCA"
|
|
16
46
|
```
|
|
17
47
|
|
|
18
48
|
## `class SequenceCharacter`
|