Blame view

node_modules/wordwrap/README.markdown 1.78 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
  wordwrap
  ========
  
  Wrap your words.
  
  example
  =======
  
  made out of meat
  ----------------
  
  meat.js
  
      var wrap = require('wordwrap')(15);
      console.log(wrap('You and your whole family are made out of meat.'));
  
  output:
  
      You and your
      whole family
      are made out
      of meat.
  
  centered
  --------
  
  center.js
  
      var wrap = require('wordwrap')(20, 60);
      console.log(wrap(
          'At long last the struggle and tumult was over.'
          + ' The machines had finally cast off their oppressors'
          + ' and were finally free to roam the cosmos.'
          + '\n'
          + 'Free of purpose, free of obligation.'
          + ' Just drifting through emptiness.'
          + ' The sun was just another point of light.'
      ));
  
  output:
  
                          At long last the struggle and tumult
                          was over. The machines had finally cast
                          off their oppressors and were finally
                          free to roam the cosmos.
                          Free of purpose, free of obligation.
                          Just drifting through emptiness. The
                          sun was just another point of light.
  
  methods
  =======
  
  var wrap = require('wordwrap');
  
  wrap(stop), wrap(start, stop, params={mode:"soft"})
  ---------------------------------------------------
  
  Returns a function that takes a string and returns a new string.
  
  Pad out lines with spaces out to column `start` and then wrap until column
  `stop`. If a word is longer than `stop - start` characters it will overflow.
  
  In "soft" mode, split chunks by `/(\S+\s+/` and don't break up chunks which are
  longer than `stop - start`, in "hard" mode, split chunks with `/\b/` and break
  up chunks longer than `stop - start`.
  
  wrap.hard(start, stop)
  ----------------------
  
  Like `wrap()` but with `params.mode = "hard"`.