@rnacanvas/search 1.2.0 → 1.2.1

package/README.md

@@ -0,0 +1,118 @@
+# Installation
+
+With `npm`:
+
+```
+npm install @rnacanvas/search
+```
+
+# Usage
+
+All exports of this package can be accessed as named imports.
+
+```javascript
+// an example import
+import { SequenceCharacter } from '@rnacanvas/search';
+```
+
+## `class SequenceCharacter`
+
+Represents a character in a sequence.
+
+```javascript
+var A = new SequenceCharacter('A');
+
+A.toString(); // "A"
+
+A.matches('A'); // true
+A.matches('G'); // false
+
+A.complements('U'); // true
+A.complements('T'); // true
+A.complements('G'); // false
+
+// case doesn't matter
+A.matches('a'); // true
+A.complements('u'); // true
+
+// IUPAC codes are recognized
+A.matches('R'); // true
+```
+
+This constructor will throw for strings that are not composed of a single character.
+
+```javascript
+// empty string
+new SequenceCharacter(''); // throws
+
+// more than one character
+new SequenceCharacter('AG'); // throws
+new SequenceCharacter('asdf'); // throws
+```
+
+Any character may be input to the constructor, though.
+
+### `toString()`
+
+Simply returns the character as a string.
+
+```javascript
+var A = new SequenceCharacter('A');
+A.toString(); // "A"
+
+var R = new SequenceCharacter('R');
+R.toString(); // "R"
+```
+
+### `matches()`
+
+Returns `true` if the character matches the input character.
+
+```javascript
+var A = new SequenceCharacter('A');
+
+A.matches('A'); // true
+A.matches('C'); // false
+
+// case doesn't matter
+A.matches('a'); // true
+
+// works for sequence character instances too
+A.matches(new SequenceCharacter('A')); // true
+```
+
+[IUPAC nucleic acid codes](https://www.bioinformatics.org/sms/iupac.html) are recognized.
+
+```javascript
+var A = new SequenceCharacter('A');
+
+A.matches('R'); // true
+A.matches('Y'); // false
+
+var N = new SequenceCharacter('N');
+
+// the any character matches any non-gap character
+N.matches('A'); // true
+N.matches('p'); // true
+
+var period = new SequenceCharacter('.');
+var dash = new SequenceCharacter('-');
+
+// gap characters only match other gap characters
+period.matches('.'); // true
+dash.matches('-'); // true
+period.matches('N'); // false
+```
+
+Will throw for empty strings and strings containing more than one character.
+
+```javascript
+var A = new SequenceCharacter('A');
+
+// empty string
+A.matches(''); // throws
+
+// strings containing more than one character
+A.matches('AG'); // throws
+A.matches('asdf'); // throws
+```

package/dist/SequenceCharacter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SequenceCharacter.d.ts","sourceRoot":"","sources":["../src/SequenceCharacter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,iBAAiB;;gBAGhB,SAAS,EAAE,MAAM;IAU7B,QAAQ,IAAI,MAAM;IAIlB,OAAO,CAAC,cAAc,EAAE,iBAAiB,GAAG,MAAM,GAAG,OAAO;IAwB5D,WAAW,CAAC,cAAc,EAAE,iBAAiB,GAAG,MAAM,GAAG,OAAO;CAiCjE"}
+{"version":3,"file":"SequenceCharacter.d.ts","sourceRoot":"","sources":["../src/SequenceCharacter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,iBAAiB;;gBAGhB,SAAS,EAAE,MAAM;IAU7B,QAAQ,IAAI,MAAM;IAIlB,OAAO,CAAC,cAAc,EAAE,iBAAiB,GAAG,MAAM,GAAG,OAAO;IA0B5D,WAAW,CAAC,cAAc,EAAE,iBAAiB,GAAG,MAAM,GAAG,OAAO;CAmCjE"}

package/dist/index.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.search=t():e.search=t()}(this,()=>(()=>{"use strict";var e={d:(t,r)=>{for(var o in r)e.o(r,o)&&!e.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:r[o]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{SequenceCharacter:()=>n});var r,o=function(e,t,r,o){if("a"===r&&!o)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof t?e!==t||!o:!t.has(e))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?o:"a"===r?o.call(e):o?o.value:t.get(e)};class n{constructor(e){if(r.set(this,void 0),0==e.length)throw new Error("Character cannot be an empty string.");if(e.length>1)throw new Error("Character must be a single character.");!function(e,t,r,o,n){if("m"===o)throw new TypeError("Private method is not writable");if("a"===o&&!n)throw new TypeError("Private accessor was defined without a setter");if("function"==typeof t?e!==t||!n:!t.has(e))throw new TypeError("Cannot write private member to an object whose class did not declare it");"a"===o?n.call(e,r):n?n.value=r:t.set(e,r)}(this,r,e,"f")}toString(){return o(this,r,"f")}matches(e){var t,n;if("string"!=typeof e&&(e=e.toString()),1!=e.length)return!1;let a=o(this,r,"f").toUpperCase();return e=e.toUpperCase(),"N"===a||"N"===e||(a in i?null!==(n=null===(t=i[a])||void 0===t?void 0:t.includes(e))&&void 0!==n&&n:a===e)}complements(e){var t,n;if("string"!=typeof e&&(e=e.toString()),1!=e.length)return!1;let i=o(this,r,"f").toUpperCase();e=e.toUpperCase();let s=[...".-"];return!(!s.includes(i)||!s.includes(e))||!s.includes(i)&&!s.includes(e)&&("N"===i&&!s.includes(e)||"N"===e&&!s.includes(i)||i in a&&null!==(n=null===(t=a[i])||void 0===t?void 0:t.includes(e))&&void 0!==n&&n)}}r=new WeakMap;const i={A:[..."A"],C:[..."C"],G:[..."G"],U:[..."UT"],T:[..."TU"],R:[..."AG"],Y:[..."CUT"],S:[..."GC"],W:[..."AUT"],K:[..."GUT"],M:[..."AC"],B:[..."CGUTYSK"],D:[..."AGUTRWK"],H:[..."ACUTYWM"],V:[..."ACGRSM"],".":[...".-"],"-":[..."-."]},a={A:[..."UT"],C:[..."G"],G:[..."CUT"],U:[..."AG"],T:[..."AG"]};return t})());
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.search=t():e.search=t()}(this,()=>(()=>{"use strict";var e={d:(t,r)=>{for(var o in r)e.o(r,o)&&!e.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:r[o]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{SequenceCharacter:()=>n});var r,o=function(e,t,r,o){if("a"===r&&!o)throw new TypeError("Private accessor was defined without a getter");if("function"==typeof t?e!==t||!o:!t.has(e))throw new TypeError("Cannot read private member from an object whose class did not declare it");return"m"===r?o:"a"===r?o.call(e):o?o.value:t.get(e)};class n{constructor(e){if(r.set(this,void 0),0==e.length)throw new Error("Character cannot be an empty string.");if(e.length>1)throw new Error("Character must be a single character.");!function(e,t,r,o,n){if("m"===o)throw new TypeError("Private method is not writable");if("a"===o&&!n)throw new TypeError("Private accessor was defined without a setter");if("function"==typeof t?e!==t||!n:!t.has(e))throw new TypeError("Cannot write private member to an object whose class did not declare it");"a"===o?n.call(e,r):n?n.value=r:t.set(e,r)}(this,r,e,"f")}toString(){return o(this,r,"f")}matches(e){var t,n;if("string"!=typeof e&&(e=e.toString()),0==e.length)throw new Error("Other character cannot be an empty string.");if(e.length>1)throw new Error("Other character cannot be multiple characters.");let i=o(this,r,"f").toUpperCase();return e=e.toUpperCase(),"N"===i||"N"===e||(i in a?null!==(n=null===(t=a[i])||void 0===t?void 0:t.includes(e))&&void 0!==n&&n:i===e)}complements(e){var t,n;if("string"!=typeof e&&(e=e.toString()),0==e.length)throw new Error("Other character cannot be an empty string.");if(e.length>1)throw new Error("Other character cannot be multiple characters.");let a=o(this,r,"f").toUpperCase();e=e.toUpperCase();let c=[...".-"];return!(!c.includes(a)||!c.includes(e))||!c.includes(a)&&!c.includes(e)&&("N"===a&&!c.includes(e)||"N"===e&&!c.includes(a)||a in i&&null!==(n=null===(t=i[a])||void 0===t?void 0:t.includes(e))&&void 0!==n&&n)}}r=new WeakMap;const a={A:[..."A"],C:[..."C"],G:[..."G"],U:[..."UT"],T:[..."TU"],R:[..."AG"],Y:[..."CUT"],S:[..."GC"],W:[..."AUT"],K:[..."GUT"],M:[..."AC"],B:[..."CGUTYSK"],D:[..."AGUTRWK"],H:[..."ACUTYWM"],V:[..."ACGRSM"],".":[...".-"],"-":[..."-."]},i={A:[..."UT"],C:[..."G"],G:[..."CUT"],U:[..."AG"],T:[..."AG"]};return t})());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rnacanvas/search",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Find motifs",
   "repository": {
     "type": "git",