drptranslator/dist/translators/dna.translator.d.ts

A DNA-RNA-Protein translator library

import { DNA } from "../symbols/dna";
import { RNA } from "../symbols/rna";
/**
 * Specialized class that allows to translate and transcript DNA sequences
 */
export declare class DNATranslator {
    /**
     * @param {string} DNA sequence to be translated into a complementary chain of DNA.
     * @returns {string} The string returned is a complementary sequence of the provided in the parameter.
     *
     * ```
     * ATGCTA
     *
     * TACGAT
     * ```
     */
    transDNAtoOpositeDNA(dna: string): string;
    /**
     * @param {string} dna sequence to be translated into a complementary chain of RNA
     * @returns {string} The string returned is a complementary sequence of the provided in the parameter
     *
     * ```
     * ATGCTA
     *
     * UACGAU
     * ```
     */
    transDNAtoRNA(dna: string): string;
    /**
     * @param {string} dna sequence to be translated into a complementary chain of Aminoacids
     * @returns {string} The string returned is a complementary sequence of the provided in the parameter
     *
     * ```
     * ATGCTA
     *
     * Tyr-Asp
     * ```
     */
    transDNAtoAA(dna: string): string;
    /**
     * @param {string} base digit string (character) that is the base to be converted into the RNA enum.
     * @returns {RNA} Returns the corresponding RNA base.
     *
     */
    matchRnaBase(base: string): RNA;
    /**
     * @param {DNA} base base which needs to be replaced.
     * @returns {RNA} Returns a RNA base which is the oposite base of the DNA base provided.
     */
    matchOpositeRnaBase(base: DNA): RNA;
    /**
     * @param {DNA} base base which needs to be replaced
     * @returns {RNA} Returns a RNA base which is the oposite base of the DNA base provided
     */
    matchOpositeDnaBase(base: DNA): DNA;
    /**
     * @param {string} base digit string (character) that is the base to be converted into the DNA enum
     * @returns {DNA} Returns the corresponding DNA base
     *
     */
    matchDnaBase(base: string): DNA;
    /**
     * @param {RNA[]} rnaArray array containing the sequence to be parsed into a string.
     * @returns {string} string containing the RNA sequence provided.
     */
    rnaToString(rnaArray: RNA[]): string;
    /**
     * @param {DNA[]} dnaArray array containing the sequence to be parsed into a string.
     * @returns {string} string containing the DNA sequence provided.
     */
    dnaToString(dnaArray: DNA[]): string;
}