@@ -632,26 +632,27 @@ var angularModule = ngClassify(coffeeScriptClass);
632
632
633
633
634
634
#### content
635
- Type: ` String `
636
- Default: ` undefined `
635
+ * Required*
636
+ Type: ` String `
637
+ Default: ` undefined `
637
638
638
639
The content that may contain CoffeeScript classes to convert to AngularJS modules
639
640
640
641
641
642
#### options
642
- Type: ` Object `
643
+ Type: ` Object `
643
644
644
645
645
646
##### options.appName
646
- Type: ` String `
647
- Default: ` 'app' `
647
+ Type: ` String `
648
+ Default: ` 'app' `
648
649
649
650
The name of the AngularJS app
650
651
651
652
652
653
##### options.prefix
653
- Type: ` String `
654
- Default: ` '' `
654
+ Type: ` String `
655
+ Default: ` '' `
655
656
656
657
To avoid potential collisions, the moduleType prefix may be set (ex: ` options.prefix = 'Ng' ` )
657
658
``` coffee
@@ -661,81 +662,49 @@ class Home extends Ng.Controller
661
662
```
662
663
663
664
664
- ##### options.data
665
- Type: ` Object `
666
- Default ` undefined `
667
-
668
- An object used for compiling [ Lo-Dash templates] ( http://lodash.com/docs#template ) .
669
- If the CoffeeScript file contains Lo-Dash template methods, they will be compiled prior to ng-classify with this object.
670
-
671
- The following shows an example of conditionally including the AngularJS module, ngMockE2E, if the environment is ` 'dev' ` .
672
- It will not be included if environment is anything other than ` 'dev' ` .
673
-
674
- ``` coffee
675
- class App extends App
676
- @constructor = [
677
- ' ngAnimate'
678
- < % if (environment == = ' dev' ) { % > ' ngMockE2E' < % } % >
679
- ' ngRoute'
680
- ]
681
- ```
682
-
683
- The above class would be compiled using the command below.
684
- ``` coffee
685
- ngClassify = require ' ng-classify'
686
- coffeeScriptClass = ' {{CoffeeScript Class as a String}}'
687
-
688
- options =
689
- data :
690
- environment : ' dev'
691
-
692
- angularModule = ngClassify coffeeScriptClass, options
693
- ```
694
-
695
-
696
665
##### options.animation
697
- Type: ` Object `
698
- Default: ` {format: 'spinalCase', prefix: '.'} `
666
+ Type: ` Object `
667
+ Default: ` {format: 'spinalCase', prefix: '.'} `
699
668
700
669
701
670
##### options.constant
702
- Type: ` Object `
703
- Default: ` {format: 'screamingSnakeCase'} `
671
+ Type: ` Object `
672
+ Default: ` {format: 'screamingSnakeCase'} `
704
673
705
674
706
675
##### options.controller
707
- Type: ` Object `
708
- Default: ` {format: 'camelCase', suffix: 'Controller'} `
676
+ Type: ` Object `
677
+ Default: ` {format: 'camelCase', suffix: 'Controller'} `
709
678
710
679
711
680
##### options.directive
712
- Type: ` Object `
713
- Default: ` {format: 'camelCase'} `
681
+ Type: ` Object `
682
+ Default: ` {format: 'camelCase'} `
714
683
715
684
716
685
##### options.factory
717
- Type: ` Object `
718
- Default: ` {format: 'upperCamelCase'} `
686
+ Type: ` Object `
687
+ Default: ` {format: 'upperCamelCase'} `
719
688
720
689
721
690
##### options.filter
722
- Type: ` Object `
723
- Default: ` {format: 'camelCase'} `
691
+ Type: ` Object `
692
+ Default: ` {format: 'camelCase'} `
724
693
725
694
726
695
##### options.provider
727
- Type: ` Object `
728
- Default: ` {format: 'camelCase', suffix: 'Provider'} `
696
+ Type: ` Object `
697
+ Default: ` {format: 'camelCase', suffix: 'Provider'} `
729
698
730
699
731
700
##### options.service
732
- Type: ` Object `
733
- Default: ` {format: 'camelCase', suffix: 'Service'} `
701
+ Type: ` Object `
702
+ Default: ` {format: 'camelCase', suffix: 'Service'} `
734
703
735
704
736
705
##### options.value
737
- Type: ` Object `
738
- Default: ` {format: 'camelCase'} `
706
+ Type: ` Object `
707
+ Default: ` {format: 'camelCase'} `
739
708
740
709
741
710
### Supported Formats
0 commit comments