NanikaStorage | API Document

伺かベースウェアのルートディレクトリオブジェクト

Hierarchy

NanikaBaseDirectory
- NanikaStorage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NanikaStorage(...paths: string[]): NanikaStorage

Overwrites FileSystemObject.constructor
- Defined in src/lib/nanika-storage.ts:62
Parameters
- Rest ...paths: string[]
  
  ベースウェアのホームディレクトリ
Returns NanikaStorage

Properties

delimiter

delimiter: string

fd

fd: number | undefined

path

path: string

sep

sep: string

Methods

Private _installBalloon

_installBalloon(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:443
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

Private _installCalendarPlugin

_installCalendarPlugin(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:459
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

Private _installCalendarSkin

_installCalendarSkin(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:455
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

Private _installChild

_installChild(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:408
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

Private _installChildren

_installChildren(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:495
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

Private _installGhost

_installGhost(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:425
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

Private _installHeadline

_installHeadline(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:451
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

Private _installPackage

_installPackage(nar: HasNanikaContainerInfoDirectory, dirpath: string | undefined, sakuraname: string | undefined): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:479
Parameters
- nar: HasNanikaContainerInfoDirectory
- dirpath: string | undefined
- sakuraname: string | undefined
Returns Promise<Array<object>>

Private _installPlugin

_installPlugin(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:447
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

Private _installShell

_installShell(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo, dirpath: string): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:434
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
- dirpath: string
Returns Promise<Array<object>>

Private _installSingleContainer

_installSingleContainer(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo, type: UkagakaContainerChildType | "supplement", target: FileSystemObject): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:467
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
- type: UkagakaContainerChildType | "supplement"
- target: FileSystemObject
Returns Promise<Array<object>>

Private _installSupplement

_installSupplement(nar: HasNanikaContainerInfoDirectory, install: UkagakaInstallInfo): Promise<Array<object>>

- Defined in src/lib/nanika-storage.ts:463
Parameters
- nar: HasNanikaContainerInfoDirectory
- install: UkagakaInstallInfo
Returns Promise<Array<object>>

access

access(callback: function): void
access(mode: number, callback: function): void
access(mode?: number): Promise<void>

Inherited from FileSystemObject.access
- Defined in node_modules/fso/src/lib/fso.d.ts:150
Parameters
- callback: function
  - - (err: ErrnoException): void
    - Parameters
      - err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.access
- Defined in node_modules/fso/src/lib/fso.d.ts:151
Parameters
- mode: number
- callback: function
  - - (err: ErrnoException): void
    - Parameters
      - err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.access
- Defined in node_modules/fso/src/lib/fso.d.ts:152
Parameters
- Optional mode: number
Returns Promise<void>

accessSync

accessSync(mode?: number): void

Inherited from FileSystemObject.accessSync
- Defined in node_modules/fso/src/lib/fso.d.ts:153
Parameters
- Optional mode: number
Returns void

appendFile

appendFile(data: any, options: object, callback: function): void
appendFile(data: any, options: object, callback: function): void
appendFile(data: any, callback: function): void
appendFile(data: any, options?: object): Promise<void>
appendFile(data: any, options?: object): Promise<void>

Inherited from FileSystemObject.appendFile
- Defined in node_modules/fso/src/lib/fso.d.ts:134
Parameters
- data: any
- options: object
- callback: function
  - - (err: ErrnoException): void
    - Parameters
      - err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.appendFile
- Defined in node_modules/fso/src/lib/fso.d.ts:135
Parameters
- data: any
- options: object
- callback: function
  - - (err: ErrnoException): void
    - Parameters
      - err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.appendFile
- Defined in node_modules/fso/src/lib/fso.d.ts:136
Parameters
- data: any
- callback: function
  - - (err: ErrnoException): void
    - Parameters
      - err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.appendFile
- Defined in node_modules/fso/src/lib/fso.d.ts:137
Parameters
- data: any
- Optional options: object
Returns Promise<void>
Inherited from FileSystemObject.appendFile
- Defined in node_modules/fso/src/lib/fso.d.ts:138
Parameters
- data: any
- Optional options: object
Returns Promise<void>

appendFileSync

appendFileSync(data: any, options?: object): void
appendFileSync(data: any, options?: object): void

Inherited from FileSystemObject.appendFileSync
- Defined in node_modules/fso/src/lib/fso.d.ts:139
Parameters
- data: any
- Optional options: object
Returns void
Inherited from FileSystemObject.appendFileSync
- Defined in node_modules/fso/src/lib/fso.d.ts:140
Parameters
- data: any
- Optional options: object
Returns void

balloon

balloon(dirpath: string): NanikaBalloonDirectory

- Defined in src/lib/nanika-storage.ts:122
"/balloon/(balloonId)" ディレクトリ

Parameters
- dirpath: string
  
  balloon ディレクトリ名
Returns NanikaBalloonDirectory

balloonBase

balloonBase(): FileSystemObject

- Defined in src/lib/nanika-storage.ts:84
"/balloon" ディレクトリ

Returns FileSystemObject

balloonName

balloonName(dirpath: string): Promise<string>

- Defined in src/lib/nanika-storage.ts:274
バルーン名

Parameters
- dirpath: string
  
  balloon ディレクトリ名
Returns Promise<string>

balloonNames

balloonNames(): Promise<Array<string>>

- Defined in src/lib/nanika-storage.ts:230
バルーン名全部

Returns Promise<Array<string>>

balloons

balloons(): Promise<Array<NanikaBalloonDirectory>>

- Defined in src/lib/nanika-storage.ts:178
balloon ディレクトリ全部

Returns Promise<Array<NanikaBalloonDirectory>>

basename

basename(): FileSystemObject

Inherited from FileSystemObject.basename
- Defined in node_modules/fso/src/lib/fso.d.ts:254
Returns FileSystemObject

calendarPlugin

calendarPlugin(dirpath: string): NanikaCalendarPluginDirectory

- Defined in src/lib/nanika-storage.ts:163
"/calendar/plugin/(calendarPluginId)" ディレクトリ

Parameters
- dirpath: string
  
  calendar plugin ディレクトリ名
Returns NanikaCalendarPluginDirectory

calendarPluginBase

calendarPluginBase(): FileSystemObject

- Defined in src/lib/nanika-storage.ts:110
"/calendar/plugin" ディレクトリ

Returns FileSystemObject

calendarPluginName

calendarPluginName(dirpath: string): Promise<string>

- Defined in src/lib/nanika-storage.ts:315
カレンダープラグイン名

Parameters
- dirpath: string
  
  calendar plugin ディレクトリ名
Returns Promise<string>

calendarPluginNames

calendarPluginNames(): Promise<Array<string>>

- Defined in src/lib/nanika-storage.ts:258
カレンダープラグイン名全部

Returns Promise<Array<string>>

calendarPlugins

calendarPlugins(): Promise<Array<NanikaCalendarPluginDirectory>>

- Defined in src/lib/nanika-storage.ts:219
calendar plugin ディレクトリ全部

Returns Promise<Array<NanikaCalendarPluginDirectory>>

calendarSkin

calendarSkin(dirpath: string): NanikaCalendarSkinDirectory

- Defined in src/lib/nanika-storage.ts:157
"/calendar/skin/(calendarSkinId)" ディレクトリ

Parameters
- dirpath: string
  
  calendar skin ディレクトリ名
Returns NanikaCalendarSkinDirectory

calendarSkinBase

calendarSkinBase(): FileSystemObject

- Defined in src/lib/nanika-storage.ts:105
"/calendar/skin" ディレクトリ

Returns FileSystemObject

calendarSkinName

calendarSkinName(dirpath: string): Promise<string>

- Defined in src/lib/nanika-storage.ts:307
カレンダースキン名

Parameters
- dirpath: string
  
  calendar skin ディレクトリ名
Returns Promise<string>

calendarSkinNames

calendarSkinNames(): Promise<Array<string>>

- Defined in src/lib/nanika-storage.ts:253
カレンダースキン名全部

Returns Promise<Array<string>>

calendarSkins

calendarSkins(): Promise<Array<NanikaCalendarSkinDirectory>>

- Defined in src/lib/nanika-storage.ts:211
calendar skin ディレクトリ全部

Returns Promise<Array<NanikaCalendarSkinDirectory>>

children

children(callback: function): void
children(): Promise<FileSystemObject[]>

Inherited from FileSystemObject.children
- Defined in node_modules/fso/src/lib/fso.d.ts:264
Parameters
- callback: function
  - - (err: ErrnoException, children: FileSystemObject[]): void
    - Parameters
      - err: ErrnoException
      - children: FileSystemObject[]
      Returns void
Returns void
Inherited from FileSystemObject.children
- Defined in node_modules/fso/src/lib/fso.d.ts:265
Returns Promise<FileSystemObject[]>

childrenAll

childrenAll(callback: function): void
childrenAll(): Promise<FileSystemObject[]>

Inherited from FileSystemObject.childrenAll
- Defined in node_modules/fso/src/lib/fso.d.ts:270
Parameters
- callback: function
  - - (err: ErrnoException, children: FileSystemObject[]): void
    - Parameters
      - err: ErrnoException
      - children: FileSystemObject[]
      Returns void
Returns void
Inherited from FileSystemObject.childrenAll
- Defined in node_modules/fso/src/lib/fso.d.ts:271
Returns Promise<FileSystemObject[]>

childrenAllSync

childrenAllSync(): FileSystemObject[]

Inherited from FileSystemObject.childrenAllSync
- Defined in node_modules/fso/src/lib/fso.d.ts:272
Returns FileSystemObject[]

childrenSync

childrenSync(): FileSystemObject[]

Inherited from FileSystemObject.childrenSync
- Defined in node_modules/fso/src/lib/fso.d.ts:266
Returns FileSystemObject[]

chmod

chmod(mode: number | string, callback: function): void
chmod(mode: number | string): Promise<void>

Inherited from FileSystemObject.chmod
- Defined in node_modules/fso/src/lib/fso.d.ts:37
Parameters
- mode: number | string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.chmod
- Defined in node_modules/fso/src/lib/fso.d.ts:38
Parameters
- mode: number | string
Returns Promise<void>

chmodSync

chmodSync(mode: number | string): void

Inherited from FileSystemObject.chmodSync
- Defined in node_modules/fso/src/lib/fso.d.ts:39
Parameters
- mode: number | string
Returns void

chown

chown(uid: number, gid: number, callback: function): void
chown(uid: number, gid: number): Promise<void>

Inherited from FileSystemObject.chown
- Defined in node_modules/fso/src/lib/fso.d.ts:28
Parameters
- uid: number
- gid: number
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.chown
- Defined in node_modules/fso/src/lib/fso.d.ts:29
Parameters
- uid: number
- gid: number
Returns Promise<void>

chownSync

chownSync(uid: number, gid: number): void

Inherited from FileSystemObject.chownSync
- Defined in node_modules/fso/src/lib/fso.d.ts:30
Parameters
- uid: number
- gid: number
Returns void

close

close(callback: function): void
close(): Promise<void>

Inherited from FileSystemObject.close
- Defined in node_modules/fso/src/lib/fso.d.ts:83
Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.close
- Defined in node_modules/fso/src/lib/fso.d.ts:84
Returns Promise<void>

closeSync

closeSync(): void

Inherited from FileSystemObject.closeSync
- Defined in node_modules/fso/src/lib/fso.d.ts:85
Returns void

createReadStream

createReadStream(options?: object): ReadStream

Inherited from FileSystemObject.createReadStream
- Defined in node_modules/fso/src/lib/fso.d.ts:154
Parameters
- Optional options: object
Returns ReadStream

createWriteStream

createWriteStream(options?: object): WriteStream

Inherited from FileSystemObject.createWriteStream
- Defined in node_modules/fso/src/lib/fso.d.ts:163
Parameters
- Optional options: object
Returns WriteStream

dirname

dirname(): FileSystemObject

Inherited from FileSystemObject.dirname
- Defined in node_modules/fso/src/lib/fso.d.ts:255
Returns FileSystemObject

exists

exists(callback: function): void
exists(): Promise<boolean>

Inherited from FileSystemObject.exists
- Defined in node_modules/fso/src/lib/fso.d.ts:147
Parameters
- callback: function
  - - (exists: boolean): void
    - Parameters
      - exists: boolean
      Returns void
Returns void
Inherited from FileSystemObject.exists
- Defined in node_modules/fso/src/lib/fso.d.ts:148
Returns Promise<boolean>

existsSync

existsSync(): boolean

Inherited from FileSystemObject.existsSync
- Defined in node_modules/fso/src/lib/fso.d.ts:149
Returns boolean

extname

extname(): string

Inherited from FileSystemObject.extname
- Defined in node_modules/fso/src/lib/fso.d.ts:256
Returns string

fchmod

fchmod(mode: number | string, callback: function): void
fchmod(mode: number | string): Promise<void>

Inherited from FileSystemObject.fchmod
- Defined in node_modules/fso/src/lib/fso.d.ts:40
Parameters
- mode: number | string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.fchmod
- Defined in node_modules/fso/src/lib/fso.d.ts:41
Parameters
- mode: number | string
Returns Promise<void>

fchmodSync

fchmodSync(mode: number | string): void

Inherited from FileSystemObject.fchmodSync
- Defined in node_modules/fso/src/lib/fso.d.ts:42
Parameters
- mode: number | string
Returns void

fchown

fchown(uid: number, gid: number, callback: function): void
fchown(uid: number, gid: number): Promise<void>

Inherited from FileSystemObject.fchown
- Defined in node_modules/fso/src/lib/fso.d.ts:31
Parameters
- uid: number
- gid: number
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.fchown
- Defined in node_modules/fso/src/lib/fso.d.ts:32
Parameters
- uid: number
- gid: number
Returns Promise<void>

fchownSync

fchownSync(uid: number, gid: number): void

Inherited from FileSystemObject.fchownSync
- Defined in node_modules/fso/src/lib/fso.d.ts:33
Parameters
- uid: number
- gid: number
Returns void

fdatasync

fdatasync(callback: Function): void
fdatasync(): Promise<void>

Inherited from FileSystemObject.fdatasync
- Defined in node_modules/fso/src/lib/fso.d.ts:171
Parameters
- callback: Function
Returns void
Inherited from FileSystemObject.fdatasync
- Defined in node_modules/fso/src/lib/fso.d.ts:172
Returns Promise<void>

fdatasyncSync

fdatasyncSync(): void

Inherited from FileSystemObject.fdatasyncSync
- Defined in node_modules/fso/src/lib/fso.d.ts:173
Returns void

filteredChildren

filteredChildren(excepts: string[] | function | undefined, callback: function): void
filteredChildren(excepts?: string[] | function): Promise<FileSystemObject[]>

Inherited from FileSystemObject.filteredChildren
- Defined in node_modules/fso/src/lib/fso.d.ts:267
Parameters
- excepts: string[] | function | undefined
- callback: function
  - - (err: ErrnoException, children: FileSystemObject[]): void
    - Parameters
      - err: ErrnoException
      - children: FileSystemObject[]
      Returns void
Returns void
Inherited from FileSystemObject.filteredChildren
- Defined in node_modules/fso/src/lib/fso.d.ts:268
Parameters
- Optional excepts: string[] | function
Returns Promise<FileSystemObject[]>

filteredChildrenAll

filteredChildrenAll(excepts: string[] | function | undefined, callback: function): void
filteredChildrenAll(excepts?: string[] | function): Promise<FileSystemObject[]>

Inherited from FileSystemObject.filteredChildrenAll
- Defined in node_modules/fso/src/lib/fso.d.ts:273
Parameters
- excepts: string[] | function | undefined
- callback: function
  - - (err: ErrnoException, children: FileSystemObject[]): void
    - Parameters
      - err: ErrnoException
      - children: FileSystemObject[]
      Returns void
Returns void
Inherited from FileSystemObject.filteredChildrenAll
- Defined in node_modules/fso/src/lib/fso.d.ts:274
Parameters
- Optional excepts: string[] | function
Returns Promise<FileSystemObject[]>

filteredChildrenAllSync

filteredChildrenAllSync(excepts?: string[] | function): FileSystemObject[]

Inherited from FileSystemObject.filteredChildrenAllSync
- Defined in node_modules/fso/src/lib/fso.d.ts:275
Parameters
- Optional excepts: string[] | function
Returns FileSystemObject[]

filteredChildrenSync

filteredChildrenSync(excepts?: string[] | function): FileSystemObject[]

Inherited from FileSystemObject.filteredChildrenSync
- Defined in node_modules/fso/src/lib/fso.d.ts:269
Parameters
- Optional excepts: string[] | function
Returns FileSystemObject[]

filteredMergeDirectory

filteredMergeDirectory(source: FileSystemObject, excepts: string[] | function | undefined, callback: function): void
filteredMergeDirectory(source: FileSystemObject, excepts?: string[] | function): Promise<void>

Inherited from FileSystemObject.filteredMergeDirectory
- Defined in node_modules/fso/src/lib/fso.d.ts:243
Parameters
- source: FileSystemObject
- excepts: string[] | function | undefined
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.filteredMergeDirectory
- Defined in node_modules/fso/src/lib/fso.d.ts:244
Parameters
- source: FileSystemObject
- Optional excepts: string[] | function
Returns Promise<void>

filteredMergeDirectorySync

filteredMergeDirectorySync(source: FileSystemObject, excepts?: string[] | function): void

Inherited from FileSystemObject.filteredMergeDirectorySync
- Defined in node_modules/fso/src/lib/fso.d.ts:245
Parameters
- source: FileSystemObject
- Optional excepts: string[] | function
Returns void

fstat

fstat(callback: function): void
fstat(): Promise<Stats>

Inherited from FileSystemObject.fstat
- Defined in node_modules/fso/src/lib/fso.d.ts:50
Parameters
- callback: function
  - - (err: ErrnoException, stats: Stats): any
    - Parameters
      - err: ErrnoException
      - stats: Stats
      Returns any
Returns void
Inherited from FileSystemObject.fstat
- Defined in node_modules/fso/src/lib/fso.d.ts:51
Returns Promise<Stats>

fstatSync

fstatSync(): Stats

Inherited from FileSystemObject.fstatSync
- Defined in node_modules/fso/src/lib/fso.d.ts:54
Returns Stats

fsync

fsync(callback: function): void
fsync(): Promise<void>

Inherited from FileSystemObject.fsync
- Defined in node_modules/fso/src/lib/fso.d.ts:102
Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.fsync
- Defined in node_modules/fso/src/lib/fso.d.ts:103
Returns Promise<void>

fsyncSync

fsyncSync(): void

Inherited from FileSystemObject.fsyncSync
- Defined in node_modules/fso/src/lib/fso.d.ts:104
Returns void

ftruncate

ftruncate(callback: function): void
ftruncate(len: number, callback: function): void
ftruncate(len?: number): Promise<void>

Inherited from FileSystemObject.ftruncate
- Defined in node_modules/fso/src/lib/fso.d.ts:24
Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.ftruncate
- Defined in node_modules/fso/src/lib/fso.d.ts:25
Parameters
- len: number
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.ftruncate
- Defined in node_modules/fso/src/lib/fso.d.ts:26
Parameters
- Optional len: number
Returns Promise<void>

ftruncateSync

ftruncateSync(len?: number): void

Inherited from FileSystemObject.ftruncateSync
- Defined in node_modules/fso/src/lib/fso.d.ts:27
Parameters
- Optional len: number
Returns void

futimes

futimes(atime: number, mtime: number, callback: function): void
futimes(atime: Date, mtime: Date, callback: function): void
futimes(atime: number, mtime: number): Promise<void>
futimes(atime: Date, mtime: Date): Promise<void>

Inherited from FileSystemObject.futimes
- Defined in node_modules/fso/src/lib/fso.d.ts:96
Parameters
- atime: number
- mtime: number
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.futimes
- Defined in node_modules/fso/src/lib/fso.d.ts:97
Parameters
- atime: Date
- mtime: Date
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.futimes
- Defined in node_modules/fso/src/lib/fso.d.ts:98
Parameters
- atime: number
- mtime: number
Returns Promise<void>
Inherited from FileSystemObject.futimes
- Defined in node_modules/fso/src/lib/fso.d.ts:99
Parameters
- atime: Date
- mtime: Date
Returns Promise<void>

futimesSync

futimesSync(atime: number, mtime: number): void
futimesSync(atime: Date, mtime: Date): void

Inherited from FileSystemObject.futimesSync
- Defined in node_modules/fso/src/lib/fso.d.ts:100
Parameters
- atime: number
- mtime: number
Returns void
Inherited from FileSystemObject.futimesSync
- Defined in node_modules/fso/src/lib/fso.d.ts:101
Parameters
- atime: Date
- mtime: Date
Returns void

ghost

ghost(dirpath: string): NanikaGhostDirectory

- Defined in src/lib/nanika-storage.ts:116
"/ghost/(ghostId)" ディレクトリ

Parameters
- dirpath: string
  
  ghost ディレクトリ名
Returns NanikaGhostDirectory

ghostBase

ghostBase(): FileSystemObject

- Defined in src/lib/nanika-storage.ts:79
"/ghost" ディレクトリ

Returns FileSystemObject

ghostMaster

ghostMaster(dirpath: string): NanikaGhostMasterDirectory

- Defined in src/lib/nanika-storage.ts:128
"/ghost/(ghostId)/ghost/master" ディレクトリ

Parameters
- dirpath: string
  
  ghost ディレクトリ名
Returns NanikaGhostMasterDirectory

ghostName

ghostName(dirpath: string): Promise<string>

- Defined in src/lib/nanika-storage.ts:266
ゴースト名

Parameters
- dirpath: string
  
  ghost ディレクトリ名
Returns Promise<string>

ghostNames

ghostNames(): Promise<Array<string>>

- Defined in src/lib/nanika-storage.ts:225
ゴースト名全部

Returns Promise<Array<string>>

ghosts

ghosts(): Promise<Array<NanikaGhostDirectory>>

- Defined in src/lib/nanika-storage.ts:170
ghost ディレクトリ全部

Returns Promise<Array<NanikaGhostDirectory>>

headline

headline(dirpath: string): NanikaHeadlineDirectory

- Defined in src/lib/nanika-storage.ts:151
"/headline/(headlineId)" ディレクトリ

Parameters
- dirpath: string
  
  headline ディレクトリ名
Returns NanikaHeadlineDirectory

headlineBase

headlineBase(): FileSystemObject

- Defined in src/lib/nanika-storage.ts:100
"/headline" ディレクトリ

Returns FileSystemObject

headlineName

headlineName(dirpath: string): Promise<string>

- Defined in src/lib/nanika-storage.ts:299
ヘッドライン名

Parameters
- dirpath: string
  
  headline ディレクトリ名
Returns Promise<string>

headlineNames

headlineNames(): Promise<Array<string>>

- Defined in src/lib/nanika-storage.ts:248
ヘッドライン名全部

Returns Promise<Array<string>>

headlines

headlines(): Promise<Array<NanikaHeadlineDirectory>>

- Defined in src/lib/nanika-storage.ts:203
headline ディレクトリ全部

Returns Promise<Array<NanikaHeadlineDirectory>>

install

install(nar: HasNanikaContainerInfoDirectory, dirpath: string | undefined, sakuraname: string | undefined): Promise<Array<any>>

- Defined in src/lib/nanika-storage.ts:380
インストールします

Parameters
- nar: HasNanikaContainerInfoDirectory
  
  インストール元
- dirpath: string | undefined
  
  ゴーストのディレクトリ名
- sakuraname: string | undefined
  
  インストールを受け付けたゴーストのさくら側名
Returns Promise<Array<any>>

isAbsolute

isAbsolute(): boolean

Inherited from FileSystemObject.isAbsolute
- Defined in node_modules/fso/src/lib/fso.d.ts:257
Returns boolean

isBlockDevice

isBlockDevice(): Promise<boolean>

Inherited from FileSystemObject.isBlockDevice
- Defined in node_modules/fso/src/lib/fso.d.ts:184
call stats' same name method

Returns Promise<boolean>

isBlockDeviceSync

isBlockDeviceSync(): boolean

Inherited from FileSystemObject.isBlockDeviceSync
- Defined in node_modules/fso/src/lib/fso.d.ts:186
call stats' same name method

Returns boolean

isCharacterDevice

isCharacterDevice(): Promise<boolean>

Inherited from FileSystemObject.isCharacterDevice
- Defined in node_modules/fso/src/lib/fso.d.ts:188
call stats' same name method

Returns Promise<boolean>

isCharacterDeviceSync

isCharacterDeviceSync(): boolean

Inherited from FileSystemObject.isCharacterDeviceSync
- Defined in node_modules/fso/src/lib/fso.d.ts:190
call stats' same name method

Returns boolean

isChildOf

isChildOf(to: string | FileSystemObject): boolean

Inherited from FileSystemObject.isChildOf
- Defined in node_modules/fso/src/lib/fso.d.ts:246
Parameters
- to: string | FileSystemObject
Returns boolean

isDirectory

isDirectory(): Promise<boolean>

Inherited from FileSystemObject.isDirectory
- Defined in node_modules/fso/src/lib/fso.d.ts:180
call stats' same name method

Returns Promise<boolean>

isDirectorySync

isDirectorySync(): boolean

Inherited from FileSystemObject.isDirectorySync
- Defined in node_modules/fso/src/lib/fso.d.ts:182
call stats' same name method

Returns boolean

isFIFO

isFIFO(): Promise<boolean>

Inherited from FileSystemObject.isFIFO
- Defined in node_modules/fso/src/lib/fso.d.ts:196
call stats' same name method

Returns Promise<boolean>

isFIFOSync

isFIFOSync(): boolean

Inherited from FileSystemObject.isFIFOSync
- Defined in node_modules/fso/src/lib/fso.d.ts:198
call stats' same name method

Returns boolean

isFile

isFile(): Promise<boolean>

Inherited from FileSystemObject.isFile
- Defined in node_modules/fso/src/lib/fso.d.ts:176
call stats' same name method

Returns Promise<boolean>

isFileSync

isFileSync(): boolean

Inherited from FileSystemObject.isFileSync
- Defined in node_modules/fso/src/lib/fso.d.ts:178
call stats' same name method

Returns boolean

isParentOf

isParentOf(to: string | FileSystemObject): boolean

Inherited from FileSystemObject.isParentOf
- Defined in node_modules/fso/src/lib/fso.d.ts:247
Parameters
- to: string | FileSystemObject
Returns boolean

isSocket

isSocket(): Promise<boolean>

Inherited from FileSystemObject.isSocket
- Defined in node_modules/fso/src/lib/fso.d.ts:200
call stats' same name method

Returns Promise<boolean>

isSocketSync

isSocketSync(): boolean

Inherited from FileSystemObject.isSocketSync
- Defined in node_modules/fso/src/lib/fso.d.ts:202
call stats' same name method

Returns boolean

isSymbolicLink

isSymbolicLink(): Promise<boolean>

Inherited from FileSystemObject.isSymbolicLink
- Defined in node_modules/fso/src/lib/fso.d.ts:192
call stats' same name method

Returns Promise<boolean>

isSymbolicLinkSync

isSymbolicLinkSync(): boolean

Inherited from FileSystemObject.isSymbolicLinkSync
- Defined in node_modules/fso/src/lib/fso.d.ts:194
call stats' same name method

Returns boolean

join

join(...paths: string[]): FileSystemObject

Inherited from FileSystemObject.join
- Defined in node_modules/fso/src/lib/fso.d.ts:262
Parameters
- Rest ...paths: string[]
Returns FileSystemObject

lchmod

lchmod(mode: number | string, callback: function): void
lchmod(mode: number | string): Promise<void>

Inherited from FileSystemObject.lchmod
- Defined in node_modules/fso/src/lib/fso.d.ts:43
Parameters
- mode: number | string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.lchmod
- Defined in node_modules/fso/src/lib/fso.d.ts:44
Parameters
- mode: number | string
Returns Promise<void>

lchmodSync

lchmodSync(mode: number | string): void

Inherited from FileSystemObject.lchmodSync
- Defined in node_modules/fso/src/lib/fso.d.ts:45
Parameters
- mode: number | string
Returns void

lchown

lchown(uid: number, gid: number, callback: function): void
lchown(uid: number, gid: number): Promise<void>

Inherited from FileSystemObject.lchown
- Defined in node_modules/fso/src/lib/fso.d.ts:34
Parameters
- uid: number
- gid: number
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.lchown
- Defined in node_modules/fso/src/lib/fso.d.ts:35
Parameters
- uid: number
- gid: number
Returns Promise<void>

lchownSync

lchownSync(uid: number, gid: number): void

Inherited from FileSystemObject.lchownSync
- Defined in node_modules/fso/src/lib/fso.d.ts:36
Parameters
- uid: number
- gid: number
Returns void

link

link(dstpath: string, callback: function): void
link(dstpath: string): Promise<void>

Inherited from FileSystemObject.link
- Defined in node_modules/fso/src/lib/fso.d.ts:55
Parameters
- dstpath: string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.link
- Defined in node_modules/fso/src/lib/fso.d.ts:56
Parameters
- dstpath: string
Returns Promise<void>

linkSync

linkSync(dstpath: string): void

Inherited from FileSystemObject.linkSync
- Defined in node_modules/fso/src/lib/fso.d.ts:57
Parameters
- dstpath: string
Returns void

lstat

lstat(callback: function): void
lstat(): Promise<Stats>

Inherited from FileSystemObject.lstat
- Defined in node_modules/fso/src/lib/fso.d.ts:48
Parameters
- callback: function
  - - (err: ErrnoException, stats: Stats): any
    - Parameters
      - err: ErrnoException
      - stats: Stats
      Returns any
Returns void
Inherited from FileSystemObject.lstat
- Defined in node_modules/fso/src/lib/fso.d.ts:49
Returns Promise<Stats>

lstatSync

lstatSync(): Stats

Inherited from FileSystemObject.lstatSync
- Defined in node_modules/fso/src/lib/fso.d.ts:53
Returns Stats

mergeDirectory

mergeDirectory(source: FileSystemObject, callback: function): void
mergeDirectory(source: FileSystemObject): Promise<void>

Inherited from FileSystemObject.mergeDirectory
- Defined in node_modules/fso/src/lib/fso.d.ts:240
Parameters
- source: FileSystemObject
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mergeDirectory
- Defined in node_modules/fso/src/lib/fso.d.ts:241
Parameters
- source: FileSystemObject
Returns Promise<void>

mergeDirectorySync

mergeDirectorySync(source: FileSystemObject): void

Inherited from FileSystemObject.mergeDirectorySync
- Defined in node_modules/fso/src/lib/fso.d.ts:242
Parameters
- source: FileSystemObject
Returns void

mkdir

mkdir(callback: function): void
mkdir(mode: number | string, callback: function): void
mkdir(mode?: number | string): Promise<void>

Inherited from FileSystemObject.mkdir
- Defined in node_modules/fso/src/lib/fso.d.ts:76
Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mkdir
- Defined in node_modules/fso/src/lib/fso.d.ts:77
Parameters
- mode: number | string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mkdir
- Defined in node_modules/fso/src/lib/fso.d.ts:78
Parameters
- Optional mode: number | string
Returns Promise<void>

mkdirAll

mkdirAll(callback: function): void
mkdirAll(mode: number | string, callback: function): void
mkdirAll(mode?: number | string): Promise<void>

Inherited from FileSystemObject.mkdirAll
- Defined in node_modules/fso/src/lib/fso.d.ts:205
like mkdir -p

Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mkdirAll
- Defined in node_modules/fso/src/lib/fso.d.ts:207
like mkdir -p

Parameters
- mode: number | string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mkdirAll
- Defined in node_modules/fso/src/lib/fso.d.ts:209
like mkdir -p

Parameters
- Optional mode: number | string
Returns Promise<void>

mkdirAllSync

mkdirAllSync(mode?: number | string): void

Inherited from FileSystemObject.mkdirAllSync
- Defined in node_modules/fso/src/lib/fso.d.ts:211
like mkdir -p

Parameters
- Optional mode: number | string
Returns void

mkdirSync

mkdirSync(mode?: number | string): void

Inherited from FileSystemObject.mkdirSync
- Defined in node_modules/fso/src/lib/fso.d.ts:79
Parameters
- Optional mode: number | string
Returns void

mkdirp

mkdirp(callback: function): void
mkdirp(mode: number | string, callback: function): void
mkdirp(mode?: number | string): Promise<void>

Inherited from FileSystemObject.mkdirp
- Defined in node_modules/fso/src/lib/fso.d.ts:213
like mkdir -p

Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mkdirp
- Defined in node_modules/fso/src/lib/fso.d.ts:215
like mkdir -p

Parameters
- mode: number | string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mkdirp
- Defined in node_modules/fso/src/lib/fso.d.ts:217
like mkdir -p

Parameters
- Optional mode: number | string
Returns Promise<void>

mkdirpSync

mkdirpSync(mode?: number | string): void

Inherited from FileSystemObject.mkdirpSync
- Defined in node_modules/fso/src/lib/fso.d.ts:219
like mkdir -p

Parameters
- Optional mode: number | string
Returns void

mkpath

mkpath(callback: function): void
mkpath(mode: number | string, callback: function): void
mkpath(mode?: number | string): Promise<void>

Inherited from FileSystemObject.mkpath
- Defined in node_modules/fso/src/lib/fso.d.ts:221
like mkdir -p

Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mkpath
- Defined in node_modules/fso/src/lib/fso.d.ts:223
like mkdir -p

Parameters
- mode: number | string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.mkpath
- Defined in node_modules/fso/src/lib/fso.d.ts:225
like mkdir -p

Parameters
- Optional mode: number | string
Returns Promise<void>

mkpathSync

mkpathSync(mode?: number | string): void

Inherited from FileSystemObject.mkpathSync
- Defined in node_modules/fso/src/lib/fso.d.ts:227
like mkdir -p

Parameters
- Optional mode: number | string
Returns void

new

new(...paths: string[]): FileSystemObject

Inherited from FileSystemObject.new
- Defined in node_modules/fso/src/lib/fso.d.ts:261
Parameters
- Rest ...paths: string[]
Returns FileSystemObject

normalize

normalize(): FileSystemObject

Inherited from FileSystemObject.normalize
- Defined in node_modules/fso/src/lib/fso.d.ts:253
Returns FileSystemObject

open

open(flags: string | number, callback: function): void
open(flags: string | number, mode: number, callback: function): void
open(flags: string | number, mode?: number): Promise<number>

Inherited from FileSystemObject.open
- Defined in node_modules/fso/src/lib/fso.d.ts:86
Parameters
- flags: string | number
- callback: function
  - - (err: ErrnoException, fd: number): void
    - Parameters
      - err: ErrnoException
      - fd: number
      Returns void
Returns void
Inherited from FileSystemObject.open
- Defined in node_modules/fso/src/lib/fso.d.ts:87
Parameters
- flags: string | number
- mode: number
- callback: function
  - - (err: ErrnoException, fd: number): void
    - Parameters
      - err: ErrnoException
      - fd: number
      Returns void
Returns void
Inherited from FileSystemObject.open
- Defined in node_modules/fso/src/lib/fso.d.ts:88
Parameters
- flags: string | number
- Optional mode: number
Returns Promise<number>

openSync

openSync(flags: string | number, mode?: number): number

Inherited from FileSystemObject.openSync
- Defined in node_modules/fso/src/lib/fso.d.ts:89
Parameters
- flags: string | number
- Optional mode: number
Returns number

parent

parent(): FileSystemObject

Inherited from FileSystemObject.parent
- Defined in node_modules/fso/src/lib/fso.d.ts:263
Returns FileSystemObject

parse

parse(): ParsedPath

Inherited from FileSystemObject.parse
- Defined in node_modules/fso/src/lib/fso.d.ts:252
Returns ParsedPath

plugin

plugin(dirpath: string): NanikaPluginDirectory

- Defined in src/lib/nanika-storage.ts:145
"/plugin/(pluginId)" ディレクトリ

Parameters
- dirpath: string
  
  plugin ディレクトリ名
Returns NanikaPluginDirectory

pluginBase

pluginBase(): FileSystemObject

- Defined in src/lib/nanika-storage.ts:95
"/plugin" ディレクトリ

Returns FileSystemObject

pluginName

pluginName(dirpath: string): Promise<string>

- Defined in src/lib/nanika-storage.ts:291
プラグイン名

Parameters
- dirpath: string
  
  plugin ディレクトリ名
Returns Promise<string>

pluginNames

pluginNames(): Promise<Array<string>>

- Defined in src/lib/nanika-storage.ts:243
プラグイン名全部

Returns Promise<Array<string>>

plugins

plugins(): Promise<Array<NanikaPluginDirectory>>

- Defined in src/lib/nanika-storage.ts:195
plugin ディレクトリ全部

Returns Promise<Array<NanikaPluginDirectory>>

profile

profile(): FileSystemObject

Overwrites NanikaBaseDirectory.profile
- Defined in src/lib/nanika-storage.ts:72
profile のファイルパス

Returns FileSystemObject

read

read(buffer: Buffer, offset: number, length: number, position: number, callback: function): void
read(buffer: Buffer, offset: number, length: number, position: number): Promise<number>

Inherited from FileSystemObject.read
- Defined in node_modules/fso/src/lib/fso.d.ts:114
Parameters
- buffer: Buffer
- offset: number
- length: number
- position: number
- callback: function
  - - (err: ErrnoException, bytesRead: number, buffer: Buffer): void
    - Parameters
      - err: ErrnoException
      - bytesRead: number
      - buffer: Buffer
      Returns void
Returns void
Inherited from FileSystemObject.read
- Defined in node_modules/fso/src/lib/fso.d.ts:115
Parameters
- buffer: Buffer
- offset: number
- length: number
- position: number
Returns Promise<number>

readFile

readFile(encoding: string, callback: function): void
readFile(options: object, callback: function): void
readFile(options: object, callback: function): void
readFile(callback: function): void
readFile(encoding: string): Promise<string>
readFile(options: object): Promise<string>
readFile(options?: object): Promise<Buffer>

Inherited from FileSystemObject.readFile
- Defined in node_modules/fso/src/lib/fso.d.ts:117
Parameters
- encoding: string
- callback: function
  - - (err: ErrnoException, data: string): void
    - Parameters
      - err: ErrnoException
      - data: string
      Returns void
Returns void
Inherited from FileSystemObject.readFile
- Defined in node_modules/fso/src/lib/fso.d.ts:118
Parameters
- options: object
- callback: function
  - - (err: ErrnoException, data: string): void
    - Parameters
      - err: ErrnoException
      - data: string
      Returns void
Returns void
Inherited from FileSystemObject.readFile
- Defined in node_modules/fso/src/lib/fso.d.ts:119
Parameters
- options: object
- callback: function
  - - (err: ErrnoException, data: Buffer): void
    - Parameters
      - err: ErrnoException
      - data: Buffer
      Returns void
Returns void
Inherited from FileSystemObject.readFile
- Defined in node_modules/fso/src/lib/fso.d.ts:120
Parameters
- callback: function
  - - (err: ErrnoException, data: Buffer): void
    - Parameters
      - err: ErrnoException
      - data: Buffer
      Returns void
Returns void
Inherited from FileSystemObject.readFile
- Defined in node_modules/fso/src/lib/fso.d.ts:121
Parameters
- encoding: string
Returns Promise<string>
Inherited from FileSystemObject.readFile
- Defined in node_modules/fso/src/lib/fso.d.ts:122
Parameters
- options: object
Returns Promise<string>
Inherited from FileSystemObject.readFile
- Defined in node_modules/fso/src/lib/fso.d.ts:123
Parameters
- Optional options: object
Returns Promise<Buffer>

readFileSync

readFileSync(encoding: string): string
readFileSync(options: object): string
readFileSync(options?: object): Buffer

Inherited from FileSystemObject.readFileSync
- Defined in node_modules/fso/src/lib/fso.d.ts:124
Parameters
- encoding: string
Returns string
Inherited from FileSystemObject.readFileSync
- Defined in node_modules/fso/src/lib/fso.d.ts:125
Parameters
- options: object
Returns string
Inherited from FileSystemObject.readFileSync
- Defined in node_modules/fso/src/lib/fso.d.ts:126
Parameters
- Optional options: object
Returns Buffer

readProfile

readProfile(): Promise<object>

Inherited from NanikaBaseDirectory.readProfile
- Defined in src/lib/nanika-container-directory.ts:88
profile を読み込む

Returns Promise<object>

readSync

readSync(buffer: Buffer, offset: number, length: number, position: number): number

Inherited from FileSystemObject.readSync
- Defined in node_modules/fso/src/lib/fso.d.ts:116
Parameters
- buffer: Buffer
- offset: number
- length: number
- position: number
Returns number

readdir

readdir(callback: function): void
readdir(): Promise<string[]>

Inherited from FileSystemObject.readdir
- Defined in node_modules/fso/src/lib/fso.d.ts:80
Parameters
- callback: function
  - - (err: ErrnoException, files: string[]): void
    - Parameters
      - err: ErrnoException
      - files: string[]
      Returns void
Returns void
Inherited from FileSystemObject.readdir
- Defined in node_modules/fso/src/lib/fso.d.ts:81
Returns Promise<string[]>

readdirAll

readdirAll(callback: function): void
readdirAll(): Promise<string[]>

Inherited from FileSystemObject.readdirAll
- Defined in node_modules/fso/src/lib/fso.d.ts:235
like ls -R

Parameters
- callback: function
  - - (err: ErrnoException, files: string[]): void
    - Parameters
      - err: ErrnoException
      - files: string[]
      Returns void
Returns void
Inherited from FileSystemObject.readdirAll
- Defined in node_modules/fso/src/lib/fso.d.ts:237
like ls -R

Returns Promise<string[]>

readdirAllSync

readdirAllSync(): string[]

Inherited from FileSystemObject.readdirAllSync
- Defined in node_modules/fso/src/lib/fso.d.ts:239
like ls -R

Returns string[]

readdirSync

readdirSync(): string[]

Inherited from FileSystemObject.readdirSync
- Defined in node_modules/fso/src/lib/fso.d.ts:82
Returns string[]

readlink

readlink(callback: function): void
readlink(): Promise<string>

Inherited from FileSystemObject.readlink
- Defined in node_modules/fso/src/lib/fso.d.ts:62
Parameters
- callback: function
  - - (err: ErrnoException, linkString: string): any
    - Parameters
      - err: ErrnoException
      - linkString: string
      Returns any
Returns void
Inherited from FileSystemObject.readlink
- Defined in node_modules/fso/src/lib/fso.d.ts:63
Returns Promise<string>

readlinkSync

readlinkSync(): string

Inherited from FileSystemObject.readlinkSync
- Defined in node_modules/fso/src/lib/fso.d.ts:64
Returns string

realpath

realpath(callback: function): void
realpath(): Promise<string>
realpath(cache: object, callback: function): void
realpath(cache: object): Promise<string>

Inherited from FileSystemObject.realpath
- Defined in node_modules/fso/src/lib/fso.d.ts:65
Parameters
- callback: function
  - - (err: ErrnoException, resolvedPath: string): any
    - Parameters
      - err: ErrnoException
      - resolvedPath: string
      Returns any
Returns void
Inherited from FileSystemObject.realpath
- Defined in node_modules/fso/src/lib/fso.d.ts:66
Returns Promise<string>
Inherited from FileSystemObject.realpath
- Defined in node_modules/fso/src/lib/fso.d.ts:67
Parameters
- cache: object
  - [path: string]: string
- callback: function
  - - (err: ErrnoException, resolvedPath: string): any
    - Parameters
      - err: ErrnoException
      - resolvedPath: string
      Returns any
Returns void
Inherited from FileSystemObject.realpath
- Defined in node_modules/fso/src/lib/fso.d.ts:68
Parameters
- cache: object
  - [path: string]: string
Returns Promise<string>

realpathSync

realpathSync(cache?: object): string

Inherited from FileSystemObject.realpathSync
- Defined in node_modules/fso/src/lib/fso.d.ts:69
Parameters
- Optional cache: object
  - [path: string]: string
Returns string

relative

relative(to: string | FileSystemObject): FileSystemObject

Inherited from FileSystemObject.relative
- Defined in node_modules/fso/src/lib/fso.d.ts:258
Parameters
- to: string | FileSystemObject
Returns FileSystemObject

rename

rename(newPath: string, callback: function): void
rename(newPath: string): Promise<void>

Inherited from FileSystemObject.rename
- Defined in node_modules/fso/src/lib/fso.d.ts:17
Parameters
- newPath: string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.rename
- Defined in node_modules/fso/src/lib/fso.d.ts:18
Parameters
- newPath: string
Returns Promise<void>

renameSync

renameSync(newPath: string): void

Inherited from FileSystemObject.renameSync
- Defined in node_modules/fso/src/lib/fso.d.ts:19
Parameters
- newPath: string
Returns void

resolve

resolve(...paths: string | FileSystemObject): FileSystemObject

Inherited from FileSystemObject.resolve
- Defined in node_modules/fso/src/lib/fso.d.ts:259
Parameters
- Rest ...paths: string | FileSystemObject
Returns FileSystemObject

rmAll

rmAll(callback: function): void
rmAll(): Promise<void>

Inherited from FileSystemObject.rmAll
- Defined in node_modules/fso/src/lib/fso.d.ts:229
like rm -rf

Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.rmAll
- Defined in node_modules/fso/src/lib/fso.d.ts:231
like rm -rf

Returns Promise<void>

rmAllSync

rmAllSync(): void

Inherited from FileSystemObject.rmAllSync
- Defined in node_modules/fso/src/lib/fso.d.ts:233
like rm -rf

Returns void

rmdir

rmdir(callback: function): void
rmdir(): Promise<void>

Inherited from FileSystemObject.rmdir
- Defined in node_modules/fso/src/lib/fso.d.ts:73
Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.rmdir
- Defined in node_modules/fso/src/lib/fso.d.ts:74
Returns Promise<void>

rmdirSync

rmdirSync(): void

Inherited from FileSystemObject.rmdirSync
- Defined in node_modules/fso/src/lib/fso.d.ts:75
Returns void

shell

shell(dirpath: string, shellpath: string): NanikaShellDirectory

- Defined in src/lib/nanika-storage.ts:137
"/ghost/(ghostId)/shell/(shellId)" ディレクトリ

Parameters
- dirpath: string
  
  ghost ディレクトリ名
- shellpath: string
  
  shell ディレクトリ名
Returns NanikaShellDirectory

shellBase

shellBase(dirpath: string): FileSystemObject

- Defined in src/lib/nanika-storage.ts:90
"/ghost/(ghostId)/shell" ディレクトリ

Parameters
- dirpath: string
  
  ghost ディレクトリ名
Returns FileSystemObject

shellName

shellName(dirpath: string, shellpath: string): Promise<string>

- Defined in src/lib/nanika-storage.ts:283
シェル名

Parameters
- dirpath: string
  
  ghost ディレクトリ名
- shellpath: string
  
  shell ディレクトリ名
Returns Promise<string>

shellNames

shellNames(dirpath: string): Promise<Array<string>>

- Defined in src/lib/nanika-storage.ts:238
シェル名全部

Parameters
- dirpath: string
  
  ghost ディレクトリ名
Returns Promise<Array<string>>

shells

shells(dirpath: string): Promise<Array<NanikaShellDirectory>>

- Defined in src/lib/nanika-storage.ts:187
shell ディレクトリ全部

Parameters
- dirpath: string
  
  ghost ディレクトリ名
Returns Promise<Array<NanikaShellDirectory>>

stat

stat(callback: function): void
stat(): Promise<Stats>

Inherited from FileSystemObject.stat
- Defined in node_modules/fso/src/lib/fso.d.ts:46
Parameters
- callback: function
  - - (err: ErrnoException, stats: Stats): any
    - Parameters
      - err: ErrnoException
      - stats: Stats
      Returns any
Returns void
Inherited from FileSystemObject.stat
- Defined in node_modules/fso/src/lib/fso.d.ts:47
Returns Promise<Stats>

statSync

statSync(): Stats

Inherited from FileSystemObject.statSync
- Defined in node_modules/fso/src/lib/fso.d.ts:52
Returns Stats

symlink

symlink(dstpath: string, type: string, callback: function): void
symlink(dstpath: string, callback: function): void
symlink(dstpath: string, type?: string): Promise<void>

Inherited from FileSystemObject.symlink
- Defined in node_modules/fso/src/lib/fso.d.ts:58
Parameters
- dstpath: string
- type: string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.symlink
- Defined in node_modules/fso/src/lib/fso.d.ts:59
Parameters
- dstpath: string
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.symlink
- Defined in node_modules/fso/src/lib/fso.d.ts:60
Parameters
- dstpath: string
- Optional type: string
Returns Promise<void>

symlinkSync

symlinkSync(dstpath: string, type?: string): void

Inherited from FileSystemObject.symlinkSync
- Defined in node_modules/fso/src/lib/fso.d.ts:61
Parameters
- dstpath: string
- Optional type: string
Returns void

toCached

toCached(): Promise<NanikaContainerSyncDirectory>

Inherited from NanikaBaseDirectory.toCached
- Defined in src/lib/nanika-container-directory.ts:102
全ての子要素のstatsと内容をキャッシュした -Sync API を提供する新しいオブジェクトを生成する。 make new directory object which provides -Sync APIs by cache all children's stats and contents.

Returns Promise<NanikaContainerSyncDirectory>

toString

toString(): string

Inherited from FileSystemObject.toString
- Defined in node_modules/fso/src/lib/fso.d.ts:15
Returns string

truncate

truncate(callback: function): void
truncate(len: number, callback: function): void
truncate(len?: number): Promise<void>

Inherited from FileSystemObject.truncate
- Defined in node_modules/fso/src/lib/fso.d.ts:20
Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.truncate
- Defined in node_modules/fso/src/lib/fso.d.ts:21
Parameters
- len: number
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.truncate
- Defined in node_modules/fso/src/lib/fso.d.ts:22
Parameters
- Optional len: number
Returns Promise<void>

truncateSync

truncateSync(len?: number): void

Inherited from FileSystemObject.truncateSync
- Defined in node_modules/fso/src/lib/fso.d.ts:23
Parameters
- Optional len: number
Returns void

uninstall

uninstall(type: "ghost", dirpath: string): Promise<void>
uninstall(type: "balloon", dirpath: string): Promise<void>
uninstall(type: "shell", dirpath: string, shellpath: string): Promise<void>
uninstall(type: "plugin", dirpath: string): Promise<void>
uninstall(type: "headline", dirpath: string): Promise<void>
uninstall(type: "calendar.skin", dirpath: string): Promise<void>
uninstall(type: "calendar.plugin", dirpath: string): Promise<void>

- Defined in src/lib/nanika-storage.ts:324
アンインストールします

Parameters
- type: "ghost"
  
  種類
- dirpath: string
  
  ゴーストのディレクトリ名
Returns Promise<void>
- Defined in src/lib/nanika-storage.ts:330
アンインストールします

Parameters
- type: "balloon"
  
  種類
- dirpath: string
  
  バルーンのディレクトリ名
Returns Promise<void>
- Defined in src/lib/nanika-storage.ts:337
アンインストールします

Parameters
- type: "shell"
  
  種類
- dirpath: string
  
  ゴーストのディレクトリ名
- shellpath: string
  
  シェルのディレクトリ名
Returns Promise<void>
- Defined in src/lib/nanika-storage.ts:343
アンインストールします

Parameters
- type: "plugin"
  
  種類
- dirpath: string
  
  プラグインのディレクトリ名
Returns Promise<void>
- Defined in src/lib/nanika-storage.ts:349
アンインストールします

Parameters
- type: "headline"
  
  種類
- dirpath: string
  
  ヘッドラインのディレクトリ名
Returns Promise<void>
- Defined in src/lib/nanika-storage.ts:355
アンインストールします

Parameters
- type: "calendar.skin"
  
  種類
- dirpath: string
  
  カレンダースキンのディレクトリ名
Returns Promise<void>
- Defined in src/lib/nanika-storage.ts:361
アンインストールします

Parameters
- type: "calendar.plugin"
  
  種類
- dirpath: string
  
  カレンダープラグインのディレクトリ名
Returns Promise<void>

unlink

unlink(callback: function): void
unlink(): Promise<void>

Inherited from FileSystemObject.unlink
- Defined in node_modules/fso/src/lib/fso.d.ts:70
Parameters
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.unlink
- Defined in node_modules/fso/src/lib/fso.d.ts:71
Returns Promise<void>

unlinkSync

unlinkSync(): void

Inherited from FileSystemObject.unlinkSync
- Defined in node_modules/fso/src/lib/fso.d.ts:72
Returns void

unwatchFile

unwatchFile(listener?: function): void

Inherited from FileSystemObject.unwatchFile
- Defined in node_modules/fso/src/lib/fso.d.ts:143
Parameters
- Optional listener: function
  - - (curr: Stats, prev: Stats): void
    - Parameters
      - curr: Stats
      - prev: Stats
      Returns void
Returns void

utimes

utimes(atime: number, mtime: number, callback: function): void
utimes(atime: Date, mtime: Date, callback: function): void
utimes(atime: number, mtime: number): Promise<void>
utimes(atime: Date, mtime: Date): Promise<void>

Inherited from FileSystemObject.utimes
- Defined in node_modules/fso/src/lib/fso.d.ts:90
Parameters
- atime: number
- mtime: number
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.utimes
- Defined in node_modules/fso/src/lib/fso.d.ts:91
Parameters
- atime: Date
- mtime: Date
- callback: function
  - - (err?: ErrnoException): void
    - Parameters
      - Optional err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.utimes
- Defined in node_modules/fso/src/lib/fso.d.ts:92
Parameters
- atime: number
- mtime: number
Returns Promise<void>
Inherited from FileSystemObject.utimes
- Defined in node_modules/fso/src/lib/fso.d.ts:93
Parameters
- atime: Date
- mtime: Date
Returns Promise<void>

utimesSync

utimesSync(atime: number, mtime: number): void
utimesSync(atime: Date, mtime: Date): void

Inherited from FileSystemObject.utimesSync
- Defined in node_modules/fso/src/lib/fso.d.ts:94
Parameters
- atime: number
- mtime: number
Returns void
Inherited from FileSystemObject.utimesSync
- Defined in node_modules/fso/src/lib/fso.d.ts:95
Parameters
- atime: Date
- mtime: Date
Returns void

watch

watch(listener?: function): FSWatcher
watch(encoding: string, listener?: function): FSWatcher
watch(options: object, listener?: function): FSWatcher

Inherited from FileSystemObject.watch
- Defined in node_modules/fso/src/lib/fso.d.ts:144
Parameters
- Optional listener: function
  - - (event: string, filename: string): any
    - Parameters
      - event: string
      - filename: string
      Returns any
Returns FSWatcher
Inherited from FileSystemObject.watch
- Defined in node_modules/fso/src/lib/fso.d.ts:145
Parameters
- encoding: string
- Optional listener: function
  - - (event: string, filename: string | Buffer): any
    - Parameters
      - event: string
      - filename: string | Buffer
      Returns any
Returns FSWatcher
Inherited from FileSystemObject.watch
- Defined in node_modules/fso/src/lib/fso.d.ts:146
Parameters
- options: object
- Optional listener: function
  - - (event: string, filename: string | Buffer): any
    - Parameters
      - event: string
      - filename: string | Buffer
      Returns any
Returns FSWatcher

watchFile

watchFile(listener: function): void
watchFile(options: object, listener: function): void

Inherited from FileSystemObject.watchFile
- Defined in node_modules/fso/src/lib/fso.d.ts:141
Parameters
- listener: function
  - - (curr: Stats, prev: Stats): void
    - Parameters
      - curr: Stats
      - prev: Stats
      Returns void
Returns void
Inherited from FileSystemObject.watchFile
- Defined in node_modules/fso/src/lib/fso.d.ts:142
Parameters
- options: object
- listener: function
  - - (curr: Stats, prev: Stats): void
    - Parameters
      - curr: Stats
      - prev: Stats
      Returns void
Returns void

write

write(buffer: Buffer, offset: number, length: number, position: number, callback: function): void
write(buffer: Buffer, offset: number, length: number, callback: function): void
write(data: any, callback: function): void
write(data: any, offset: number, callback: function): void
write(data: any, offset: number, encoding: string, callback: function): void
write(buffer: Buffer, offset: number, length: number, position?: number): Promise<number>
write(data: any, position?: number, enconding?: string): Promise<number>

Inherited from FileSystemObject.write
- Defined in node_modules/fso/src/lib/fso.d.ts:105
Parameters
- buffer: Buffer
- offset: number
- length: number
- position: number
- callback: function
  - - (err: ErrnoException, written: number, buffer: Buffer): void
    - Parameters
      - err: ErrnoException
      - written: number
      - buffer: Buffer
      Returns void
Returns void
Inherited from FileSystemObject.write
- Defined in node_modules/fso/src/lib/fso.d.ts:106
Parameters
- buffer: Buffer
- offset: number
- length: number
- callback: function
  - - (err: ErrnoException, written: number, buffer: Buffer): void
    - Parameters
      - err: ErrnoException
      - written: number
      - buffer: Buffer
      Returns void
Returns void
Inherited from FileSystemObject.write
- Defined in node_modules/fso/src/lib/fso.d.ts:107
Parameters
- data: any
- callback: function
  - - (err: ErrnoException, written: number, str: string): void
    - Parameters
      - err: ErrnoException
      - written: number
      - str: string
      Returns void
Returns void
Inherited from FileSystemObject.write
- Defined in node_modules/fso/src/lib/fso.d.ts:108
Parameters
- data: any
- offset: number
- callback: function
  - - (err: ErrnoException, written: number, str: string): void
    - Parameters
      - err: ErrnoException
      - written: number
      - str: string
      Returns void
Returns void
Inherited from FileSystemObject.write
- Defined in node_modules/fso/src/lib/fso.d.ts:109
Parameters
- data: any
- offset: number
- encoding: string
- callback: function
  - - (err: ErrnoException, written: number, str: string): void
    - Parameters
      - err: ErrnoException
      - written: number
      - str: string
      Returns void
Returns void
Inherited from FileSystemObject.write
- Defined in node_modules/fso/src/lib/fso.d.ts:110
Parameters
- buffer: Buffer
- offset: number
- length: number
- Optional position: number
Returns Promise<number>
Inherited from FileSystemObject.write
- Defined in node_modules/fso/src/lib/fso.d.ts:111
Parameters
- data: any
- Optional position: number
- Optional enconding: string
Returns Promise<number>

writeFile

writeFile(data: any, callback: function): void
writeFile(data: any, options: object, callback: function): void
writeFile(data: any, options: object, callback: function): void
writeFile(data: any, options?: object): Promise<void>
writeFile(data: any, options?: object): Promise<void>

Inherited from FileSystemObject.writeFile
- Defined in node_modules/fso/src/lib/fso.d.ts:127
Parameters
- data: any
- callback: function
  - - (err: ErrnoException): void
    - Parameters
      - err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.writeFile
- Defined in node_modules/fso/src/lib/fso.d.ts:128
Parameters
- data: any
- options: object
- callback: function
  - - (err: ErrnoException): void
    - Parameters
      - err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.writeFile
- Defined in node_modules/fso/src/lib/fso.d.ts:129
Parameters
- data: any
- options: object
- callback: function
  - - (err: ErrnoException): void
    - Parameters
      - err: ErrnoException
      Returns void
Returns void
Inherited from FileSystemObject.writeFile
- Defined in node_modules/fso/src/lib/fso.d.ts:130
Parameters
- data: any
- Optional options: object
Returns Promise<void>
Inherited from FileSystemObject.writeFile
- Defined in node_modules/fso/src/lib/fso.d.ts:131
Parameters
- data: any
- Optional options: object
Returns Promise<void>

writeFileSync

writeFileSync(data: any, options?: object): void
writeFileSync(data: any, options?: object): void

Inherited from FileSystemObject.writeFileSync
- Defined in node_modules/fso/src/lib/fso.d.ts:132
Parameters
- data: any
- Optional options: object
Returns void
Inherited from FileSystemObject.writeFileSync
- Defined in node_modules/fso/src/lib/fso.d.ts:133
Parameters
- data: any
- Optional options: object
Returns void

writeProfile

writeProfile(profile: Profile): Promise<void>

Inherited from NanikaBaseDirectory.writeProfile
- Defined in src/lib/nanika-container-directory.ts:79
profile を書き込む

Parameters
- profile: Profile
  
  profile
Returns Promise<void>

writeSync

writeSync(buffer: Buffer, offset: number, length: number, position?: number): number
writeSync(data: any, position?: number, enconding?: string): number

Inherited from FileSystemObject.writeSync
- Defined in node_modules/fso/src/lib/fso.d.ts:112
Parameters
- buffer: Buffer
- offset: number
- length: number
- Optional position: number
Returns number
Inherited from FileSystemObject.writeSync
- Defined in node_modules/fso/src/lib/fso.d.ts:113
Parameters
- data: any
- Optional position: number
- Optional enconding: string
Returns number

Static Private _filterRemove

_filterRemove(target: FileSystemObject, exceptPaths: string[]): Promise<void>

- Defined in src/lib/nanika-storage.ts:31
Parameters
- target: FileSystemObject
- exceptPaths: string[]
Returns Promise<void>

Static Private _mergeInstallDirectory

_mergeInstallDirectory(source: HasNanikaContainerInfoDirectory | FileSystemObject, target: FileSystemObject, install: UkagakaInstallInfo): Promise<void>

- Defined in src/lib/nanika-storage.ts:42
Parameters
- source: HasNanikaContainerInfoDirectory | FileSystemObject
- target: FileSystemObject
- install: UkagakaInstallInfo
Returns Promise<void>

Static format

format(pathObject: ParsedPath): FileSystemObject

Inherited from FileSystemObject.format
- Defined in node_modules/fso/src/lib/fso.d.ts:251
Parameters
- pathObject: ParsedPath
Returns FileSystemObject

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Rest ...paths: string[]

Returns NanikaStorage

Properties

delimiter

fd

path

sep

Methods

Private _installBalloon

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>

Private _installCalendarPlugin

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>

Private _installCalendarSkin

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>

Private _installChild

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>

Private _installChildren

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>

Private _installGhost

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>

Private _installHeadline

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>

Private _installPackage

Parameters

nar: HasNanikaContainerInfoDirectory

dirpath: string | undefined

sakuraname: string | undefined

Returns Promise<Array<object>>

Private _installPlugin

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>

Private _installShell

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

dirpath: string

Returns Promise<Array<object>>

Private _installSingleContainer

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

type: UkagakaContainerChildType | "supplement"

target: FileSystemObject

Returns Promise<Array<object>>

Private _installSupplement

Parameters

nar: HasNanikaContainerInfoDirectory

install: UkagakaInstallInfo

Returns Promise<Array<object>>