@stdlib/buffer-from-string/docs/types/index.d.ts

Allocate a buffer containing a provided string.

/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* 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.
*/

// TypeScript Version: 4.1

/// <reference types="node"/>

import { Buffer } from 'buffer';

/**
* Allocates a buffer containing a provided string.
*
* @param str - input string
* @param encoding - character encoding (default: 'utf8')
* @throws second argument must be a valid encoding
* @returns new `Buffer` instance
*
* @example
* var buf = fromString( 'beep boop' );
* // returns <Buffer>
*/
declare function fromString( str: string, encoding?: string ): Buffer;


// EXPORTS //

export = fromString;