@stdlib/string-base-left-pad 0.0.2 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2022 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # lpad
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -71,6 +82,9 @@ str = lpad( 'boop', 12, 'beep' );
     var str = lpad( 'boop', 10, 'beep' ); // => length 12
     // returns 'beepbeepboop'
 
+    str = str.substring( 0, 10 ); // => length 10
+    // returns 'beepbeepbo'
+
     str = str.substring( str.length-10 ); // => length 10
     // returns 'epbeepboop'
     ```
@@ -109,14 +123,28 @@ str = lpad( 'boop', 12, 'beep' );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
+var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
+var papply = require( '@stdlib/utils-papply' );
+var papplyRight = require( '@stdlib/utils-papply-right' );
+var naryFunction = require( '@stdlib/utils-nary-function' );
+var map = require( '@stdlib/utils-map' );
+var logEach = require( '@stdlib/console-log-each' );
 var lpad = require( '@stdlib/string-base-left-pad' );
 
+// Define a string to pad:
 var str = 'beep';
-var i;
-for ( i = 0; i < 100; i++ ) {
-    console.log( lpad( str, discreteUniform( str.length, str.length+10 ), 'b' ) );
-}
+
+// Generate random lengths:
+var lens = discreteUniform( 10, str.length, str.length+10 );
+
+// Create a function for creating padded strings:
+var fcn = naryFunction( papply( papplyRight( lpad, 'b' ), str ), 1 );
+
+// Generate padded strings:
+var out = map( lens, fcn );
+
+// Print results:
+logEach( '%s', out );
 ```
 
 </section>
@@ -157,7 +185,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -170,8 +198,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/string-base-left-pad.svg
 [npm-url]: https://npmjs.org/package/@stdlib/string-base-left-pad
 
-[test-image]: https://github.com/stdlib-js/string-base-left-pad/actions/workflows/test.yml/badge.svg?branch=v0.0.2
-[test-url]: https://github.com/stdlib-js/string-base-left-pad/actions/workflows/test.yml?query=branch:v0.0.2
+[test-image]: https://github.com/stdlib-js/string-base-left-pad/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/string-base-left-pad/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-base-left-pad/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/string-base-left-pad?branch=main
@@ -184,7 +212,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import lpad from '../docs/types/index';
+export = lpad;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var a=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var u=a(function(p,n){
+var c=require('@stdlib/string-base-repeat/dist'),l=require('@stdlib/math-base-special-ceil/dist');function s(r,e,i){var t=(e-r.length)/i.length;return t<=0?r:(t=l(t),c(i,t)+r)}n.exports=s
+});var v=u();module.exports=v;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar repeat = require( '@stdlib/string-base-repeat' );\nvar ceil = require( '@stdlib/math-base-special-ceil' );\n\n\n// MAIN //\n\n/**\n* Left pads a string such that the padded string has a length of at least `len`.\n*\n* @param {string} str - string to pad\n* @param {NonNegativeInteger} len - minimum string length\n* @param {string} pad - string used to pad\n* @returns {string} padded string\n*\n* @example\n* var str = lpad( 'a', 5, ' ' );\n* // returns '    a'\n*\n* @example\n* var str = lpad( 'beep', 10, 'b' );\n* // returns 'bbbbbbbeep'\n*\n* @example\n* var str = lpad( 'boop', 12, 'beep' );\n* // returns 'beepbeepboop'\n*/\nfunction lpad( str, len, pad ) {\n\tvar n = ( len - str.length ) / pad.length;\n\tif ( n <= 0 ) {\n\t\treturn str;\n\t}\n\tn = ceil( n );\n\treturn repeat( pad, n ) + str;\n}\n\n\n// EXPORTS //\n\nmodule.exports = lpad;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Left pad a string such that the padded string has a length of at least `len`.\n*\n* @module @stdlib/string-base-left-pad\n*\n* @example\n* var lpad = require( '@stdlib/string-base-left-pad' );\n*\n* var str = lpad( 'a', 5, ' ' );\n* // returns '    a'\n*\n* str = lpad( 'beep', 10, 'b' );\n* // returns 'bbbbbbbeep'\n*\n* str = lpad( 'boop', 12, 'beep' );\n* // returns 'beepbeepboop'\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,4BAA6B,EAC/CC,EAAO,QAAS,gCAAiC,EAyBrD,SAASC,EAAMC,EAAKC,EAAKC,EAAM,CAC9B,IAAIC,GAAMF,EAAMD,EAAI,QAAWE,EAAI,OACnC,OAAKC,GAAK,EACFH,GAERG,EAAIL,EAAMK,CAAE,EACLN,EAAQK,EAAKC,CAAE,EAAIH,EAC3B,CAKAJ,EAAO,QAAUG,ICpBjB,IAAIK,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "repeat", "ceil", "lpad", "str", "len", "pad", "n", "main"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Left pads a string such that the padded string has a length of at least `len`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-base-left-pad",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Left pad a string.",
   "license": "Apache-2.0",
   "author": {
@@ -37,16 +37,21 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-special-ceil": "^0.0.x",
-    "@stdlib/string-base-repeat": "^0.0.x"
+    "@stdlib/math-base-special-ceil": "^0.1.0",
+    "@stdlib/string-base-repeat": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-string": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/random-base-discrete-uniform": "^0.0.x",
+    "@stdlib/assert-is-string": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/console-log-each": "^0.0.2",
+    "@stdlib/random-array-discrete-uniform": "^0.0.1",
+    "@stdlib/utils-map": "^0.0.1",
+    "@stdlib/utils-nary-function": "^0.1.0",
+    "@stdlib/utils-papply": "^0.1.0",
+    "@stdlib/utils-papply-right": "^0.1.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -79,7 +84,7 @@
     "left"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,38 +0,0 @@
-
-{{alias}}( str, len, pad )
-    Left pads a string such that the padded string has a length of at least
-    `len`.
-
-    An output string is not guaranteed to have a length of exactly `len`, but to
-    have a length of at least `len`. To generate a padded string having a length
-    equal to `len`, post-process a padded string by trimming off excess
-    characters.
-
-    Parameters
-    ----------
-    str: string
-        Input string.
-
-    len: integer
-        Minimum string length.
-
-    pad: string
-        String used to pad.
-
-    Returns
-    -------
-    out: string
-        Padded string.
-
-    Examples
-    --------
-    > var out = {{alias}}( 'a', 5, ' ' )
-    '    a'
-    > out = {{alias}}( 'beep', 10, 'b' )
-    'bbbbbbbeep'
-    > out = {{alias}}( 'boop', 12, 'beep' )
-    'beepbeepboop'
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,59 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2022 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.
-*/
-
-import lpad = require( './index' );
-
-
-// TESTS //
-
-// The function returns a string...
-{
-	lpad( 'abd', 5, ' ' ); // $ExpectType string
-	lpad( 'abd', 4, 'x' ); // $ExpectType string
-}
-
-// The compiler throws an error if the function is provided arguments having invalid types...
-{
-	lpad( true, 6, ' ' ); // $ExpectError
-	lpad( false, 6, ' ' ); // $ExpectError
-	lpad( 3, 6, ' ' ); // $ExpectError
-	lpad( [], 6, ' ' ); // $ExpectError
-	lpad( {}, 6, ' ' ); // $ExpectError
-	lpad( ( x: number ): number => x, 6, ' ' ); // $ExpectError
-
-	lpad( 'abd', true, ' ' ); // $ExpectError
-	lpad( 'abd', false, ' ' ); // $ExpectError
-	lpad( 'abd', 'abc', ' ' ); // $ExpectError
-	lpad( 'abd', [], 0, ' ' ); // $ExpectError
-	lpad( 'abd', {}, 0, ' ' ); // $ExpectError
-	lpad( 'abd', ( x: number ): number => x, 0, ' ' ); // $ExpectError
-
-	lpad( 'abd', 6, true ); // $ExpectError
-	lpad( 'abd', 6, false ); // $ExpectError
-	lpad( 'abd', 6, 123 ); // $ExpectError
-	lpad( 'abd', 6, [] ); // $ExpectError
-	lpad( 'abd', 6, {} ); // $ExpectError
-	lpad( 'abd', 6, /[a-z]/ ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided insufficient arguments...
-{
-	lpad(); // $ExpectError
-	lpad( 'abc' ); // $ExpectError
-	lpad( 'abc', 6 ); // $ExpectError
-}