Class ProjectFile

Implements

ProjectFile

Constructors

constructor

new ProjectFile(
    file: File | SourceFile,
    project: Project,
    readOnly?: boolean,
): ProjectFile
Parameters
- file: File | SourceFile
- project: Project
- OptionalreadOnly: boolean
Returns ProjectFile
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:7

Methods

addStatement

addStatement(code?: string): Statement
Parameters
- Optionalcode: string
Returns Statement
Implementation of ProjectFile.addStatement
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:30

fix

fix(): void
Returns void
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:25

format

format(formatter?: Formatter): Promise<void>
Parameters
- Optionalformatter: Formatter
Returns Promise<void>
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:26

getContent

getContent(): string
Returns string
Implementation of ProjectFile.getContent
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:10

getDiagnostics

getDiagnostics(): Promise<Diagnostic[]>
Returns Promise<Diagnostic[]>
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:13

getName

getName(): string
Returns string
Implementation of ProjectFile.getName
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:9

getOutput

getOutput(throwOnError?: boolean): Promise<File[]>
Parameters
- OptionalthrowOnError: boolean
Returns Promise<File[]>
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:17

getPath

getPath(): string
Returns string
Implementation of ProjectFile.getPath
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:8

getRecords

getRecords(throwOnError?: boolean): Promise<Database>
Parameters
- OptionalthrowOnError: boolean
Returns Promise<Database>
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:15

getRecordsNoDedupe

getRecordsNoDedupe(
throwOnError?: boolean,
sysIds?: Set<string>,
): Promise<Record[]>
Parameters
- OptionalthrowOnError: boolean
- OptionalsysIds: Set<string>
Returns Promise<Record[]>
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:16

getShapes

getShapes(throwOnError?: boolean): Promise<Shape<unknown>[]>
Parameters
- OptionalthrowOnError: boolean
Returns Promise<Shape<unknown>[]>
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:14

isInFluentHostedPluginDir

isInFluentHostedPluginDir(pluginId?: string): boolean
Parameters
- OptionalpluginId: string
Returns boolean
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:20

isInMetadataDir

isInMetadataDir(): boolean
Returns boolean
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:19

isInServerModulesDir

isInServerModulesDir(): boolean
Returns boolean
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:21

isInUiHtmlContentDir

isInUiHtmlContentDir(): boolean
Returns boolean
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:22

isKeysRegistry

isKeysRegistry(): boolean
Returns boolean
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:23

isUpdateSetXml

isUpdateSetXml(): boolean
Returns boolean
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:18

reload

reload(refreshFromFileSystem?: boolean): void
Parameters
- OptionalrefreshFromFileSystem: boolean
Returns void
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:24

remove

remove(): void
Returns void
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:28

save

save(): void
Returns void
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:27

setContent

setContent(content: string): void
Parameters
- content: string
Returns void
Implementation of ProjectFile.setContent
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:11

setReadOnly

setReadOnly(readOnly: boolean): void
Parameters
- readOnly: boolean
Returns void
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:12

unwrap

unwrap(): File | SourceFile
Returns File | SourceFile
- Defined in node_modules/.pnpm/@servicenow+sdk-api@4.7.0/node_modules/@servicenow/sdk-api/dist/project-file.d.ts:29