[F] getVisibilitySuffix
Call Signature
Section titled “Call Signature”function getVisibilitySuffix( program, visibilityFilter, canonicalVisibilityFilter?): string;Provides a naming suffix to create a unique name for a type with the given visibility filter applied.
If the provided VisibilityFilter is equivalent to the canonical visibility filter (default: Read-only), the suffix will be an empty string. Othwerwise, the visibility modifiers will be appended in PascalCase, with
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
program | Program | |
visibilityFilter | VisibilityFilter | |
canonicalVisibilityFilter? | VisibilityFilter |
Returns
Section titled “Returns”string
Call Signature
Section titled “Call Signature”function getVisibilitySuffix(visibility, canonicalVisibility?): string;Provides a naming suffix to create a unique name for a type with this visibility.
The canonical visibility (default Visibility.Read) gets empty suffix,
otherwise visibilities are joined in pascal-case with Or. And Item is
if Visibility.Item is produced.
Examples (with canonicalVisibility = Visibility.Read):
- Visibility.Read => ""
- Visibility.Update => “Update”
- Visibility.Create | Visibility.Update => “CreateOrUpdate”
- Visibility.Create | Visibility.Item => “CreateItem”
- Visibility.Create | Visibility.Update | Visibility.Item => “CreateOrUpdateItem”
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
visibility | Visibility |
canonicalVisibility? | Visibility |
Returns
Section titled “Returns”string
Deprecated
Section titled “Deprecated”Prefer using getVisibilitySuffix with a Program and VisibilityFilter instead.