@signalk/nmea0183-signalk/dist/lib/getTagBlock.d.ts

A node.js/javascript parser for NMEA0183 sentences. Sentences are parsed to Signal K format.

/**
 * Copyright 2016 Signal K and Fabian Tollenaar <fabian@signalk.org>.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import type { ParserTags } from '../types';
export interface TagBlockResult {
    sentence: string;
    tags: ParserTags;
}
/**
 * Parses an NMEA 0183 v4 tag block wrapping a sentence.
 *
 * Input example:
 *   `\\s:compass,c:1438489697*13\\$IIDBT,035.53,f,010.83,M,005.85,F*23`
 * Output:
 *   { sentence: '$IIDBT,...', tags: { source: 'compass', timestamp: '2015-08-02T...' } }
 *
 * Returns `false` when no tag block is present so callers can fall back to
 * default tags without a separate `null` vs `undefined` split.
 */
declare function getTagBlock(sentence: string): TagBlockResult | false;
export default getTagBlock;
//# sourceMappingURL=getTagBlock.d.ts.map